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 import datetime
  24
  25 # -- General configuration ------------------------------------------------
  26
  27 # If your documentation needs a minimal Sphinx version, state it here.
  28 #
  29 # needs_sphinx = '1.0'
  30
  31 # Add any Sphinx extension module names here, as strings. They can be
  32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  33 # ones.
  34 extensions = ['redjack.sphinx.lua', 'sphinxcontrib.httpdomain', 'sphinxjsondomain',
  35               'sphinxcontrib.fulltoc', 'changelog']
  36 primary_domain = 'lua'
  37
  38 # Add any paths that contain templates here, relative to this directory.
  39 templates_path = ['_templates']
  40
  41 # The suffix(es) of source filenames.
  42 # You can specify multiple suffix as a list of string:
  43 #
  44 # source_suffix = ['.rst', '.md']
  45 source_suffix = '.rst'
  46
  47 # The master toctree document.
  48 master_doc = 'index_TOC'
  49
  50 # General information about the project.
  51 project = 'dnsdist'
  52 copyright = 'PowerDNS.COM BV and its contributors'
  53 author = 'PowerDNS.COM BV and its contributors'
  54
  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
  57 # built documents.
  58 #
  59 # The short X.Y version.
  60 # version = '1.3'
  61 # The full version, including alpha/beta/rc tags.
  62 # release = '1.3.0'
  63
  64 # The language for content autogenerated by Sphinx. Refer to documentation
  65 # for a list of supported languages.
  66 #
  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.
  69 language = None
  70
  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',
  78                     'common/secpoll.rst',
  79                     'common/api/*.rst',
  80                     'common/tarball-pgp-keys.rst']
  81
  82 # The name of the Pygments (syntax highlighting) style to use.
  83 pygments_style = 'sphinx'
  84
  85 # If true, `todo` and `todoList` produce output, else they produce nothing.
  86 todo_include_todos = False
  87
  88 # -- Changelog Options ----------------------------------------------------
  89
  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"
  93
  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']
  96
  97 changelog_hide_tags_in_entry = True
  98
  99 # -- Options for HTML output ----------------------------------------------
 100
 101 # The theme to use for HTML and HTML Help pages.  See the documentation for
 102 # a list of builtin themes.
 103 #
 104 html_theme_path = ['_templates']
 105 html_theme = 'pdns_html'
 106
 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
 109 # documentation.
 110 #
 111 html_theme_options = {}
 112
 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']
 117
 118 html_favicon = '_static/favicon.ico'
 119
 120
 121 # -- Options for HTMLHelp output ------------------------------------------
 122
 123 # Output file base name for HTML help builder.
 124 htmlhelp_basename = 'dnsdistdoc'
 125
 126
 127 # -- Options for LaTeX output ---------------------------------------------
 128
 129 latex_elements = {
 130     # The paper size ('letterpaper' or 'a4paper').
 131     #
 132     'papersize': 'a4paper',
 133
 134     # The font size ('10pt', '11pt' or '12pt').
 135     #
 136     # 'pointsize': '10pt',
 137
 138     # Additional stuff for the LaTeX preamble.
 139     #
 140     # 'preamble': '',
 141
 142     # Latex figure (float) alignment
 143     #
 144     # 'figure_align': 'htbp',
 145 }
 146
 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]).
 150 latex_documents = [
 151     (master_doc, 'dnsdist.tex', 'dnsdist',
 152      'PowerDNS.COM BV', 'manual'),
 153 ]
 154
 155 latex_logo = '_static/powerdns-logo-trans.png'
 156
 157
 158 # -- Options for manual page output ---------------------------------------
 159
 160 # One entry per manual page. List of tuples
 161 # (source start file, name, description, authors, manual section).
 162 man_pages = [
 163     ('manpages/dnsdist.1', 'dnsdist',
 164      'A DNS and DoS aware, scriptable loadbalancer',
 165      [author], 1)
 166 ]
 167
 168
 169 # -- Options for Texinfo output -------------------------------------------
 170
 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.',
 177      'Miscellaneous'),
 178 ]
 179
 180
 181
 182 # -- Options for Epub output ----------------------------------------------
 183
 184 # Bibliographic Dublin Core info.
 185 epub_title = project
 186 epub_author = author
 187 epub_publisher = author
 188 epub_copyright = copyright
 189
 190 # The unique identifier of the text. This can be a ISBN number
 191 # or the project homepage.
 192 #
 193 # epub_identifier = ''
 194
 195 # A unique identification for the text.
 196 #
 197 # epub_uid = ''
 198
 199 # A list of files that should not be packed into the epub file.
 200 epub_exclude_files = ['search.html']
 201
 202