pdns/dnsdistdist/docs/conf.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3 #
   4 # dnsdist documentation build configuration file, created by
   5 # sphinx-quickstart on Thu Feb  9 00:08:08 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
  24 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain',
  34               'sphinxcontrib.fulltoc', 'changelog']
  35 primary_domain = 'lua'
  36
  37 # Add any paths that contain templates here, relative to this directory.
  38 templates_path = ['_templates']
  39
  40 # The suffix(es) of source filenames.
  41 # You can specify multiple suffix as a list of string:
  42 #
  43 # source_suffix = ['.rst', '.md']
  44 source_suffix = '.rst'
  45
  46 # The master toctree document.
  47 master_doc = 'index_TOC'
  48
  49 # General information about the project.
  50 project = 'dnsdist'
  51 copyright = '2015-2019, PowerDNS.COM BV and its contributors'
  52 author = 'PowerDNS.COM BV and its contributors'
  53
  54 # The version info for the project you're documenting, acts as replacement for
  55 # |version| and |release|, also used in various other places throughout the
  56 # built documents.
  57 #
  58 # The short X.Y version.
  59 # version = '1.3'
  60 # The full version, including alpha/beta/rc tags.
  61 # release = '1.3.0'
  62
  63 # The language for content autogenerated by Sphinx. Refer to documentation
  64 # for a list of supported languages.
  65 #
  66 # This is also used if you do content translation via gettext catalogs.
  67 # Usually you set "language" from the command line for these cases.
  68 language = None
  69
  70 # List of patterns, relative to source directory, that match files and
  71 # directories to ignore when looking for source files.
  72 # This patterns also effect to html_static_path and html_extra_path
  73 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv',
  74                     'http-api/override.rst',
  75                     'common/zonemetadata.rst',
  76                     'common/endpoint-servers-config.rst',
  77                     'common/secpoll.rst',
  78                     'common/api/*.rst',
  79                     'common/tarball-pgp-keys.rst']
  80
  81 # The name of the Pygments (syntax highlighting) style to use.
  82 pygments_style = 'sphinx'
  83
  84 # If true, `todo` and `todoList` produce output, else they produce nothing.
  85 todo_include_todos = False
  86
  87 # -- Changelog Options ----------------------------------------------------
  88
  89 changelog_render_ticket = "https://github.com/PowerDNS/pdns/issues/%s"
  90 changelog_render_pullreq = "https://github.com/PowerDNS/pdns/pull/%s"
  91 changelog_render_changeset = "https://github.com/PowerDNS/pdns/commit/%s"
  92
  93 changelog_sections = ['New Features', 'Improvements', 'Bug Fixes', 'Removals']
  94 changelog_inner_tag_sort = ['Security', 'DNS over HTTPS', 'DNS over TLS', 'DNSCrypt', 'DNSTAP', 'Protobuf', 'Performance', 'Webserver', 'Metrics']
  95
  96 changelog_render_tags = False
  97
  98 # -- Options for HTML output ----------------------------------------------
  99
 100 # The theme to use for HTML and HTML Help pages.  See the documentation for
 101 # a list of builtin themes.
 102 #
 103 html_theme_path = ['_templates']
 104 html_theme = 'pdns_html'
 105
 106 # Theme options are theme-specific and customize the look and feel of a theme
 107 # further.  For a list of options available for each theme, see the
 108 # documentation.
 109 #
 110 html_theme_options = {}
 111
 112 # Add any paths that contain custom static files (such as style sheets) here,
 113 # relative to this directory. They are copied after the builtin static files,
 114 # so a file named "default.css" will overwrite the builtin "default.css".
 115 html_static_path = ['_static']
 116
 117 html_favicon = '_static/favicon.ico'
 118
 119
 120 # -- Options for HTMLHelp output ------------------------------------------
 121
 122 # Output file base name for HTML help builder.
 123 htmlhelp_basename = 'dnsdistdoc'
 124
 125
 126 # -- Options for LaTeX output ---------------------------------------------
 127
 128 latex_elements = {
 129     # The paper size ('letterpaper' or 'a4paper').
 130     #
 131     'papersize': 'a4paper',
 132
 133     # The font size ('10pt', '11pt' or '12pt').
 134     #
 135     # 'pointsize': '10pt',
 136
 137     # Additional stuff for the LaTeX preamble.
 138     #
 139     # 'preamble': '',
 140
 141     # Latex figure (float) alignment
 142     #
 143     # 'figure_align': 'htbp',
 144 }
 145
 146 # Grouping the document tree into LaTeX files. List of tuples
 147 # (source start file, target name, title,
 148 #  author, documentclass [howto, manual, or own class]).
 149 latex_documents = [
 150     (master_doc, 'dnsdist.tex', 'dnsdist',
 151      'PowerDNS.COM BV', 'manual'),
 152 ]
 153
 154 latex_logo = '_static/powerdns-logo-trans.png'
 155
 156
 157 # -- Options for manual page output ---------------------------------------
 158
 159 # One entry per manual page. List of tuples
 160 # (source start file, name, description, authors, manual section).
 161 man_pages = [
 162     ('manpages/dnsdist.1', 'dnsdist',
 163      'A DNS and DoS aware, scriptable loadbalancer',
 164      [author], 1)
 165 ]
 166
 167
 168 # -- Options for Texinfo output -------------------------------------------
 169
 170 # Grouping the document tree into Texinfo files. List of tuples
 171 # (source start file, target name, title, author,
 172 #  dir menu entry, description, category)
 173 texinfo_documents = [
 174     (master_doc, 'dnsdist', 'dnsdist',
 175      author, 'dnsdist', 'One line description of project.',
 176      'Miscellaneous'),
 177 ]
 178
 179
 180
 181 # -- Options for Epub output ----------------------------------------------
 182
 183 # Bibliographic Dublin Core info.
 184 epub_title = project
 185 epub_author = author
 186 epub_publisher = author
 187 epub_copyright = copyright
 188
 189 # The unique identifier of the text. This can be a ISBN number
 190 # or the project homepage.
 191 #
 192 # epub_identifier = ''
 193
 194 # A unique identification for the text.
 195 #
 196 # epub_uid = ''
 197
 198 # A list of files that should not be packed into the epub file.
 199 epub_exclude_files = ['search.html']
 200
 201