2 # -*- coding: utf-8 -*-
4 # PowerDNS Recursor documentation build configuration file, created by
5 # sphinx-quickstart on Wed Jun 28 14:56:44 2017.
7 # This file is execfile()d with the current directory set to its
10 # Note that not all possible configuration values are present in this
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
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.
23 # sys.path.insert(0, os.path.abspath('.'))
24 import guzzle_sphinx_theme
26 # -- General configuration ------------------------------------------------
28 # If your documentation needs a minimal Sphinx version, state it here.
30 # needs_sphinx = '1.0'
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 #extensions = ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain']
37 extensions
= ['sphinxcontrib.httpdomain', 'sphinxjsondomain',
38 'sphinxcontrib.fulltoc', 'changelog']
40 # Add any paths that contain templates here, relative to this directory.
41 templates_path
= ['_templates']
43 # The suffix(es) of source filenames.
44 # You can specify multiple suffix as a list of string:
46 # source_suffix = ['.rst', '.md']
47 source_suffix
= '.rst'
49 # The master toctree document.
50 master_doc
= 'indexTOC'
52 # General information about the project.
53 project
= 'PowerDNS Recursor'
54 copyright
= '2001-2018, PowerDNS.COM BV'
55 author
= 'PowerDNS.COM BV'
57 # The version info for the project you're documenting, acts as replacement for
58 # |version| and |release|, also used in various other places throughout the
61 # The short X.Y version.
63 # The full version, including alpha/beta/rc tags.
64 #release = '4.1.0-alpha0'
66 # The language for content autogenerated by Sphinx. Refer to documentation
67 # for a list of supported languages.
69 # This is also used if you do content translation via gettext catalogs.
70 # Usually you set "language" from the command line for these cases.
73 # List of patterns, relative to source directory, that match files and
74 # directories to ignore when looking for source files.
75 # This patterns also effect to html_static_path and html_extra_path
76 exclude_patterns
= ['_build', 'Thumbs.db', '.DS_Store',
78 'security-advisories/security-policy.rst',
80 'common/api/zone.rst']
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style
= 'sphinx'
85 # If true, `todo` and `todoList` produce output, else they produce nothing.
86 todo_include_todos
= False
89 # -- Changelog Options ----------------------------------------------------
91 changelog_render_ticket
= "https://github.com/PowerDNS/pdns/issues/%s"
92 changelog_render_pullreq
= "https://github.com/PowerDNS/pdns/pull/%s"
93 changelog_render_changeset
= "https://github.com/PowerDNS/pdns/commit/%s"
95 changelog_sections
= ['New Features', 'Removed Features', 'Improvements', 'Bug Fixes']
96 changelog_inner_tag_sort
= ['Internals', 'API', 'Tools', 'ALIAS', 'DNSUpdate', 'BIND', 'MySQL', 'Postgresql', 'Oracle', 'LDAP', 'GeoIP', 'Remote']
98 changelog_render_tags
= False
100 # -- Options for HTML output ----------------------------------------------
102 # The theme to use for HTML and HTML Help pages. See the documentation for
103 # a list of builtin themes.
105 html_theme_path
= guzzle_sphinx_theme
.html_theme_path()
106 html_theme
= 'guzzle_sphinx_theme'
108 extensions
.append("guzzle_sphinx_theme")
110 html_theme_options
= {
111 # Set the name of the project to appear in the sidebar
112 "project_nav_name": "PowerDNS Authoritative Server",
114 html_favicon
= 'common/favicon.ico'
116 # Theme options are theme-specific and customize the look and feel of a theme
117 # further. For a list of options available for each theme, see the
120 # html_theme_options = {}
122 # Add any paths that contain custom static files (such as style sheets) here,
123 # relative to this directory. They are copied after the builtin static files,
124 # so a file named "default.css" will overwrite the builtin "default.css".
125 html_static_path
= ['_static']
126 html_style
= 'pdns.css'
129 # -- Options for HTMLHelp output ------------------------------------------
131 # Output file base name for HTML help builder.
132 htmlhelp_basename
= 'PowerDNSAuthoritativedoc'
135 # -- Options for LaTeX output ---------------------------------------------
138 # The paper size ('letterpaper' or 'a4paper').
140 'papersize': 'a4paper',
142 # The font size ('10pt', '11pt' or '12pt').
144 # 'pointsize': '10pt',
146 # Additional stuff for the LaTeX preamble.
150 # Latex figure (float) alignment
152 # 'figure_align': 'htbp',
155 # Grouping the document tree into LaTeX files. List of tuples
156 # (source start file, target name, title,
157 # author, documentclass [howto, manual, or own class]).
159 (master_doc
, 'PowerDNS-Authoritative.tex', 'PowerDNS Authoritative Server Documentation',
160 'PowerDNS.COM BV', 'manual'),
163 latex_logo
= 'common/powerdns-logo-500px.png'
165 # -- Options for manual page output ---------------------------------------
167 # One entry per manual page. List of tuples
168 # (source start file, name, description, authors, manual section).
170 for f
in glob
.glob('manpages/*.1.rst'):
171 srcname
= '.'.join(f
.split('.')[:-1])
172 destname
= srcname
.split('/')[-1][:-2]
173 man_pages
.append((srcname
, destname
, '', [author
], 1))
175 # -- Options for Texinfo output -------------------------------------------
177 # Grouping the document tree into Texinfo files. List of tuples
178 # (source start file, target name, title, author,
179 # dir menu entry, description, category)
180 #texinfo_documents = [
181 # (master_doc, 'PowerDNSRecursor', 'PowerDNS Recursor Documentation',
182 # author, 'PowerDNSRecursor', 'One line description of project.',
188 # -- Options for Epub output ----------------------------------------------
190 # Bibliographic Dublin Core info.
193 epub_publisher
= author
194 epub_copyright
= copyright
196 # The unique identifier of the text. This can be a ISBN number
197 # or the project homepage.
199 # epub_identifier = ''
201 # A unique identification for the text.
205 # A list of files that should not be packed into the epub file.
206 epub_exclude_files
= ['search.html']