2 # -*- coding: utf-8 -*-
4 # dnsdist documentation build configuration file, created by
5 # sphinx-quickstart on Thu Feb 9 00:08:08 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.
22 # sys.path.insert(0, os.path.abspath('.'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
29 # needs_sphinx = '1.0'
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 extensions
= ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain',
35 'sphinxcontrib.fulltoc', 'changelog']
36 primary_domain
= 'lua'
38 # Add any paths that contain templates here, relative to this directory.
39 templates_path
= ['_templates']
41 # The suffix(es) of source filenames.
42 # You can specify multiple suffix as a list of string:
44 # source_suffix = ['.rst', '.md']
45 source_suffix
= '.rst'
47 # The master toctree document.
48 master_doc
= 'index_TOC'
50 # General information about the project.
52 copyright
= 'PowerDNS.COM BV and its contributors'
53 author
= 'PowerDNS.COM BV and its contributors'
55 # The version info for the project you're documenting, acts as replacement for
56 # |version| and |release|, also used in various other places throughout the
59 # The short X.Y version.
61 # The full version, including alpha/beta/rc tags.
64 # The language for content autogenerated by Sphinx. Refer to documentation
65 # for a list of supported languages.
67 # This is also used if you do content translation via gettext catalogs.
68 # Usually you set "language" from the command line for these cases.
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 # This patterns also effect to html_static_path and html_extra_path
74 exclude_patterns
= ['_build', 'Thumbs.db', '.DS_Store', '.venv',
75 'http-api/override.rst',
76 'common/zonemetadata.rst',
77 'common/endpoint-servers-config.rst',
80 'common/tarball-pgp-keys.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
88 # -- Changelog Options ----------------------------------------------------
90 changelog_render_ticket
= "https://github.com/PowerDNS/pdns/issues/%s"
91 changelog_render_pullreq
= "https://github.com/PowerDNS/pdns/pull/%s"
92 changelog_render_changeset
= "https://github.com/PowerDNS/pdns/commit/%s"
94 changelog_sections
= ['New Features', 'Improvements', 'Bug Fixes', 'Removals']
95 changelog_inner_tag_sort
= ['Security', 'DNS over HTTPS', 'DNS over TLS', 'DNSCrypt', 'DNSTAP', 'Protobuf', 'Performance', 'Webserver', 'Metrics']
97 changelog_hide_tags_in_entry
= True
99 # -- Options for HTML output ----------------------------------------------
101 # The theme to use for HTML and HTML Help pages. See the documentation for
102 # a list of builtin themes.
104 html_theme_path
= ['_templates']
105 html_theme
= 'pdns_html'
107 # Theme options are theme-specific and customize the look and feel of a theme
108 # further. For a list of options available for each theme, see the
111 html_theme_options
= {}
113 # Add any paths that contain custom static files (such as style sheets) here,
114 # relative to this directory. They are copied after the builtin static files,
115 # so a file named "default.css" will overwrite the builtin "default.css".
116 html_static_path
= ['_static']
118 html_favicon
= '_static/favicon.ico'
121 # -- Options for HTMLHelp output ------------------------------------------
123 # Output file base name for HTML help builder.
124 htmlhelp_basename
= 'dnsdistdoc'
127 # -- Options for LaTeX output ---------------------------------------------
130 # The paper size ('letterpaper' or 'a4paper').
132 'papersize': 'a4paper',
134 # The font size ('10pt', '11pt' or '12pt').
136 # 'pointsize': '10pt',
138 # Additional stuff for the LaTeX preamble.
142 # Latex figure (float) alignment
144 # 'figure_align': 'htbp',
147 # Grouping the document tree into LaTeX files. List of tuples
148 # (source start file, target name, title,
149 # author, documentclass [howto, manual, or own class]).
151 (master_doc
, 'dnsdist.tex', 'dnsdist',
152 'PowerDNS.COM BV', 'manual'),
155 latex_logo
= '_static/powerdns-logo-trans.png'
158 # -- Options for manual page output ---------------------------------------
160 # One entry per manual page. List of tuples
161 # (source start file, name, description, authors, manual section).
163 ('manpages/dnsdist.1', 'dnsdist',
164 'A DNS and DoS aware, scriptable loadbalancer',
169 # -- Options for Texinfo output -------------------------------------------
171 # Grouping the document tree into Texinfo files. List of tuples
172 # (source start file, target name, title, author,
173 # dir menu entry, description, category)
174 texinfo_documents
= [
175 (master_doc
, 'dnsdist', 'dnsdist',
176 author
, 'dnsdist', 'One line description of project.',
182 # -- Options for Epub output ----------------------------------------------
184 # Bibliographic Dublin Core info.
187 epub_publisher
= author
188 epub_copyright
= copyright
190 # The unique identifier of the text. This can be a ISBN number
191 # or the project homepage.
193 # epub_identifier = ''
195 # A unique identification for the text.
199 # A list of files that should not be packed into the epub file.
200 epub_exclude_files
= ['search.html']