conf.py 8.96 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
# -*- coding: utf-8 -*-
#
# Knot DNS documentation build configuration file, created by
# sphinx-quickstart on Tue Apr 15 13:48:28 2014.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

14
import sys, os, time, logging
15

16 17
sys.setrecursionlimit(1500)

18 19 20
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
21
sys.path.insert(0, os.path.abspath('.'))
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
Jan Včelák's avatar
Jan Včelák committed
42
master_doc = 'index'
43 44

# General information about the project.
45
project = 'Knot DNS'
46
copyright_year = 2019
47 48 49 50 51
current_year = time.localtime().tm_year
if current_year > copyright_year:
    logging.warning('Copyright year is %d, but current year is %d.'%(copyright_year, current_year))
    logging.warning('Maybe you should update copyright_year in doc/conf.py?')
copyright = u'Copyright 2010–%d, CZ.NIC, z.s.p.o.' % copyright_year
52
author = 'CZ.NIC Labs <https://www.knot-dns.cz>'
53 54 55 56 57 58

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
59
#version = ''
60
# The full version, including alpha/beta/rc tags.
61
#release = ''
62 63 64 65 66 67 68

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
69
#today = False
70 71 72 73 74
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
75
exclude_patterns = ['_build', 'modules']
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
101
html_theme = 'theme_html'
102 103 104 105 106 107 108

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
109
html_theme_path = ['.']
110 111 112 113 114 115 116 117 118 119

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
120
html_logo = 'logo.png'
121 122 123 124 125 126 127 128 129

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Jan Včelák's avatar
Jan Včelák committed
130
#html_static_path = ['_static']
131 132 133 134 135 136 137

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
138
#html_use_smartypants = False
139 140 141 142 143 144 145 146 147

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
148
html_domain_indices = False
149 150

# If false, no index is generated.
151
html_use_index = False
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'KnotDNSdoc'

# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
180
'papersize': 'a4paper',
181 182 183 184 185 186

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
187 188 189 190 191 192

# No empty pages between chapters
'classoptions': ',openany,oneside',

# Language preferences
'babel': '\\usepackage[english]{babel}',
193 194 195 196 197
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
198
  ('index', 'KnotDNS.tex', 'Knot DNS Documentation', copyright, 'manual'),
199 200 201 202
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
203
latex_logo = 'logo.eps'
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
219
latex_domain_indices = False
220 221 222 223 224

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
225
man_pages = [
Daniel Salzman's avatar
Daniel Salzman committed
226 227 228 229
    ('reference',         'knot.conf',     'Knot DNS configuration file',               author, 5),
    ('man_knotc',         'knotc',         'Knot DNS control utility',                  author, 8),
    ('man_knotd',         'knotd',         'Knot DNS server daemon',                    author, 8),
    ('man_keymgr',        'keymgr',        'Knot DNS key management utility',           author, 8),
230
    ('man_kjournalprint', 'kjournalprint', 'Knot DNS journal print utility',            author, 8),
Daniel Salzman's avatar
Daniel Salzman committed
231 232 233 234 235
    ('man_kdig',          'kdig',          'Advanced DNS lookup utility',               author, 1),
    ('man_khost',         'khost',         'Simple DNS lookup utility',                 author, 1),
    ('man_knsec3hash',    'knsec3hash',    'Simple utility to compute NSEC3 hash',      author, 1),
    ('man_knsupdate',     'knsupdate',     'Dynamic DNS update utility',                author, 1),
    ('man_kzonecheck',    'kzonecheck',    'Knot DNS zone check tool',                  author, 1),
236
]
237 238 239 240 241 242 243 244 245 246

# If true, show URL addresses after external links.
#man_show_urls = False

# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
247 248
  ('index', 'knot', 'Knot DNS Documentation', author,
   'KnotDNS', 'Knot Authoritative DNS Server', 'Miscellaneous')
249 250 251 252 253 254 255 256 257 258
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'