1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# SPDX-License-Identifier: GPL-3.0-or-later
# -*- coding: utf-8 -*-
import os
import re
import subprocess
import sphinx_rtd_theme
# -- General configuration -----------------------------------------------------
if os.environ.get('READTHEDOCS', None) == 'True':
subprocess.call('doxygen')
# Add any Sphinx extension module names here, as strings.
extensions = [
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'breathe',
]
theme_major = sphinx_rtd_theme.__version__.partition('.')[0]
if theme_major >= '2':
extensions.append('sphinxcontrib.jquery')
# Breathe configuration
breathe_projects = {"libkres": "doxyxml"}
breathe_default_project = "libkres"
breathe_domain_by_extension = {"h": "c"}
# The suffix of source filenames.
source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Knot Resolver'
copyright = u'CZ.NIC labs'
with open('../../meson.build') as f:
for line in f:
match = re.match(r"\s*version\s*:\s*'([^']+)'.*", line)
if match is not None:
version = match.groups()[0]
release = version
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
highlight_language = 'c'
primary_domain = 'py'
# -- Options for HTML output ---------------------------------------------------
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_static']
# Output file base name for HTML help builder.
htmlhelp_basename = 'apidoc'
# Theme
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'logo_only': True, # if we have a html_logo below, this shows only the logo with no title text
# ToC options
'collapse_navigation': False,
'sticky_navigation': True,
}
html_logo = '../_static/logo-negativ-dev.svg'
html_css_files = [
'css/custom.css',
'css/dev.css',
]
# -- Options for LaTeX output --------------------------------------------------
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'format.tex', u'Knot Resolver',
u'CZ.NIC Labs', 'manual'),
]
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'libkres', u'libkres documentation',
[u'CZ.NIC Labs'], 1)
]
# reStructuredText that will be included at the beginning of every source file that is read.
# This is a possible place to add substitutions that should be available in every file.
rst_prolog = """
.. |yaml| replace:: YAML
.. |lua| replace:: Lua
"""
|
