]>
Commit | Line | Data |
---|---|---|
223bb49e PL |
1 | #!/usr/bin/env python3 |
2 | # -*- coding: utf-8 -*- | |
3 | # | |
4 | # PowerDNS Recursor documentation build configuration file, created by | |
5 | # sphinx-quickstart on Wed Jun 28 14:56:44 2017. | |
6 | # | |
7 | # This file is execfile()d with the current directory set to its | |
8 | # containing dir. | |
9 | # | |
10 | # Note that not all possible configuration values are present in this | |
11 | # autogenerated file. | |
12 | # | |
13 | # All configuration values have a default; values that are commented out | |
14 | # serve to show the default. | |
15 | ||
16 | # If extensions (or modules to document with autodoc) are in another directory, | |
17 | # add these directories to sys.path here. If the directory is relative to the | |
18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | |
19 | # | |
20 | # import os | |
21 | # import sys | |
22 | # sys.path.insert(0, os.path.abspath('.')) | |
23 | import guzzle_sphinx_theme | |
d169d153 | 24 | import datetime |
223bb49e PL |
25 | |
26 | # -- General configuration ------------------------------------------------ | |
27 | ||
28 | # If your documentation needs a minimal Sphinx version, state it here. | |
29 | # | |
30 | # needs_sphinx = '1.0' | |
31 | ||
32 | # Add any Sphinx extension module names here, as strings. They can be | |
33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
34 | # ones. | |
35 | #extensions = [] | |
36 | #extensions = ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain'] | |
37 | extensions = ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain', | |
38 | 'sphinxcontrib.fulltoc', 'changelog'] | |
39 | primary_domain = 'lua' | |
40 | ||
41 | # Add any paths that contain templates here, relative to this directory. | |
42 | templates_path = ['_templates'] | |
43 | ||
44 | # The suffix(es) of source filenames. | |
45 | # You can specify multiple suffix as a list of string: | |
46 | # | |
47 | # source_suffix = ['.rst', '.md'] | |
48 | source_suffix = '.rst' | |
49 | ||
50 | # The master toctree document. | |
51 | master_doc = 'indexTOC' | |
52 | ||
53 | # General information about the project. | |
54 | project = 'PowerDNS Recursor' | |
13f74e4c | 55 | copyright = 'PowerDNS.COM BV' |
223bb49e PL |
56 | author = 'PowerDNS.COM BV' |
57 | ||
58 | # The version info for the project you're documenting, acts as replacement for | |
59 | # |version| and |release|, also used in various other places throughout the | |
60 | # built documents. | |
61 | # | |
62 | # The short X.Y version. | |
760d679c | 63 | #version = '4.1' |
223bb49e | 64 | # The full version, including alpha/beta/rc tags. |
f52b0223 | 65 | #release = '4.1.0-alpha1' |
223bb49e PL |
66 | |
67 | # The language for content autogenerated by Sphinx. Refer to documentation | |
68 | # for a list of supported languages. | |
69 | # | |
70 | # This is also used if you do content translation via gettext catalogs. | |
71 | # Usually you set "language" from the command line for these cases. | |
72 | language = None | |
73 | ||
74 | # List of patterns, relative to source directory, that match files and | |
75 | # directories to ignore when looking for source files. | |
76 | # This patterns also effect to html_static_path and html_extra_path | |
f8f74ab5 | 77 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv', |
223bb49e PL |
78 | 'http-api/override.rst', |
79 | 'common/zonemetadata.rst', | |
0e2063c3 | 80 | 'common/endpoint-servers-config.rst', |
6d500cf4 PL |
81 | 'common/secpoll.rst', |
82 | 'common/api/zone.rst'] | |
223bb49e PL |
83 | |
84 | # The name of the Pygments (syntax highlighting) style to use. | |
85 | pygments_style = 'sphinx' | |
86 | ||
87 | # If true, `todo` and `todoList` produce output, else they produce nothing. | |
88 | todo_include_todos = False | |
89 | ||
90 | ||
91 | # -- Changelog Options ---------------------------------------------------- | |
92 | ||
18330d2c | 93 | changelog_render_ticket = "https://github.com/PowerDNS/pdns/issues/%s" |
223bb49e PL |
94 | changelog_render_pullreq = "https://github.com/PowerDNS/pdns/pull/%s" |
95 | changelog_render_changeset = "https://github.com/PowerDNS/pdns/commit/%s" | |
96 | ||
5eae5820 | 97 | changelog_sections = ['New Features', 'Improvements', 'Bug Fixes', 'Removals'] |
223bb49e PL |
98 | changelog_inner_tag_sort = ['General', 'DNSSEC', 'Protobuf', 'RPZ'] |
99 | ||
0a957dfb | 100 | changelog_hide_tags_in_entry = True |
223bb49e PL |
101 | |
102 | # -- Options for HTML output ---------------------------------------------- | |
103 | ||
104 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
105 | # a list of builtin themes. | |
106 | # | |
107 | html_theme_path = guzzle_sphinx_theme.html_theme_path() | |
108 | html_theme = 'guzzle_sphinx_theme' | |
109 | ||
110 | extensions.append("guzzle_sphinx_theme") | |
111 | ||
112 | html_theme_options = { | |
113 | # Set the name of the project to appear in the sidebar | |
114 | "project_nav_name": "PowerDNS Recursor", | |
115 | } | |
116 | html_favicon = 'common/favicon.ico' | |
117 | ||
118 | # Theme options are theme-specific and customize the look and feel of a theme | |
119 | # further. For a list of options available for each theme, see the | |
120 | # documentation. | |
121 | # | |
122 | # html_theme_options = {} | |
123 | ||
124 | # Add any paths that contain custom static files (such as style sheets) here, | |
125 | # relative to this directory. They are copied after the builtin static files, | |
126 | # so a file named "default.css" will overwrite the builtin "default.css". | |
127 | html_static_path = ['_static'] | |
128 | html_style = 'pdns.css' | |
129 | ||
130 | ||
131 | # -- Options for HTMLHelp output ------------------------------------------ | |
132 | ||
133 | # Output file base name for HTML help builder. | |
134 | htmlhelp_basename = 'PowerDNSRecursordoc' | |
135 | ||
136 | ||
137 | # -- Options for LaTeX output --------------------------------------------- | |
138 | ||
139 | latex_elements = { | |
140 | # The paper size ('letterpaper' or 'a4paper'). | |
141 | # | |
142 | 'papersize': 'a4paper', | |
143 | ||
144 | # The font size ('10pt', '11pt' or '12pt'). | |
145 | # | |
146 | # 'pointsize': '10pt', | |
147 | ||
148 | # Additional stuff for the LaTeX preamble. | |
149 | # | |
150 | # 'preamble': '', | |
151 | ||
152 | # Latex figure (float) alignment | |
153 | # | |
154 | # 'figure_align': 'htbp', | |
155 | } | |
156 | ||
157 | # Grouping the document tree into LaTeX files. List of tuples | |
158 | # (source start file, target name, title, | |
159 | # author, documentclass [howto, manual, or own class]). | |
160 | latex_documents = [ | |
161 | (master_doc, 'PowerDNS-Recursor.tex', 'PowerDNS Recursor Documentation', | |
162 | 'PowerDNS.COM BV', 'manual'), | |
163 | ] | |
164 | ||
165 | latex_logo = 'common/powerdns-logo-500px.png' | |
166 | ||
167 | ||
168 | # -- Options for manual page output --------------------------------------- | |
169 | ||
170 | # One entry per manual page. List of tuples | |
171 | # (source start file, name, description, authors, manual section). | |
172 | man_pages = [ | |
f52b0223 PL |
173 | ('manpages/rec_control.1', 'rec_control', 'Command line tool to control a running Recursor', [author], 1), |
174 | ('manpages/pdns_recursor.1', 'pdns_recursor', 'The PowerDNS Recursor binary', [author], 1) | |
223bb49e PL |
175 | ] |
176 | ||
177 | ||
178 | # -- Options for Texinfo output ------------------------------------------- | |
179 | ||
180 | # Grouping the document tree into Texinfo files. List of tuples | |
181 | # (source start file, target name, title, author, | |
182 | # dir menu entry, description, category) | |
183 | #texinfo_documents = [ | |
184 | # (master_doc, 'PowerDNSRecursor', 'PowerDNS Recursor Documentation', | |
185 | # author, 'PowerDNSRecursor', 'One line description of project.', | |
186 | # 'Miscellaneous'), | |
187 | #] | |
188 | ||
189 | ||
190 | ||
191 | # -- Options for Epub output ---------------------------------------------- | |
192 | ||
193 | # Bibliographic Dublin Core info. | |
194 | epub_title = project | |
195 | epub_author = author | |
196 | epub_publisher = author | |
197 | epub_copyright = copyright | |
198 | ||
199 | # The unique identifier of the text. This can be a ISBN number | |
200 | # or the project homepage. | |
201 | # | |
202 | # epub_identifier = '' | |
203 | ||
204 | # A unique identification for the text. | |
205 | # | |
206 | # epub_uid = '' | |
207 | ||
208 | # A list of files that should not be packed into the epub file. | |
209 | epub_exclude_files = ['search.html'] |