1############################################################################
2# Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3#
4# This Source Code Form is subject to the terms of the Mozilla Public
5# License, v. 2.0. If a copy of the MPL was not distributed with this
6# file, You can obtain one at http://mozilla.org/MPL/2.0/.
7#
8# See the COPYRIGHT file distributed with this work for additional
9# information regarding copyright ownership.
10############################################################################
11
12# flake8: noqa: E501
13
14#
15# Configuration file for the Sphinx documentation builder.
16#
17# This file only contains a selection of the most common options. For a full
18# list see the documentation:
19# http://www.sphinx-doc.org/en/master/config
20
21# -- Path setup --------------------------------------------------------------
22
23# If extensions (or modules to document with autodoc) are in another directory,
24# add these directories to sys.path here. If the directory is relative to the
25# documentation root, use os.path.abspath to make it absolute, like shown here.
26#
27# import os
28# import sys
29# sys.path.insert(0, os.path.abspath('.'))
30
31
32# -- Project information -----------------------------------------------------
33
34project = u'BIND 9'
35# pylint: disable=redefined-builtin
36copyright = u'2020, Internet Systems Consortium'
37author = u'Internet Systems Consortium'
38
39# -- General configuration ---------------------------------------------------
40
41# Add any Sphinx extension module names here, as strings. They can be
42# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43# ones.
44extensions = []
45
46# Add any paths that contain templates here, relative to this directory.
47templates_path = ['_templates']
48
49# List of patterns, relative to source directory, that match files and
50# directories to ignore when looking for source files.
51# This pattern also affects html_static_path and html_extra_path.
52exclude_patterns = [
53    '_build',
54    'Thumbs.db',
55    '.DS_Store',
56    '*.grammar.rst',
57    '*.zoneopts.rst',
58    'catz.rst',
59    'dlz.rst',
60    'dnssec.rst',
61    'dyndb.rst',
62    'logging-cattegories.rst',
63    'managed-keys.rst',
64    'pkcs11.rst',
65    'plugins.rst'
66    ]
67
68# The master toctree document.
69master_doc = 'index'
70
71# -- Options for HTML output -------------------------------------------------
72
73# The theme to use for HTML and HTML Help pages.  See the documentation for
74# a list of builtin themes.
75#
76html_theme = 'sphinx_rtd_theme'
77
78# -- Options for LaTeX output ------------------------------------------------
79latex_engine = 'xelatex'
80
81# pylint disable=line-too-long
82latex_documents = [
83    (master_doc, 'Bv9ARM.tex', u'BIND 9 Administrator Reference Manual', author, 'manual'),
84    ]
85
86latex_logo = "isc-logo.pdf"
87