1############################################################################ 2# Copyright (C) Internet Systems Consortium, Inc. ("ISC") 3# 4# SPDX-License-Identifier: MPL-2.0 5# 6# This Source Code Form is subject to the terms of the Mozilla Public 7# License, v. 2.0. If a copy of the MPL was not distributed with this 8# file, you can obtain one at https://mozilla.org/MPL/2.0/. 9# 10# See the COPYRIGHT file distributed with this work for additional 11# information regarding copyright ownership. 12############################################################################ 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# https://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# -- Project information ----------------------------------------------------- 32 33project = "BIND 9" 34# pylint: disable=wrong-import-position 35import datetime 36 37year = datetime.datetime.now().year 38# pylint: disable=redefined-builtin 39copyright = "%d, Internet Systems Consortium" % year 40author = "Internet Systems Consortium" 41 42# -- General configuration --------------------------------------------------- 43 44# Build man pages directly in _build/man/, not in _build/man/<section>/. 45# This is what the shell code in Makefile.am expects. 46man_make_section_directory = False 47 48# Add any Sphinx extension module names here, as strings. They can be 49# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 50# ones. 51extensions = [] 52 53# Add any paths that contain templates here, relative to this directory. 54templates_path = ["../arm/_templates"] 55 56# List of patterns, relative to source directory, that match files and 57# directories to ignore when looking for source files. 58# This pattern also affects html_static_path and html_extra_path. 59exclude_patterns = [ 60 "_build", 61 "Thumbs.db", 62 ".DS_Store", 63] 64 65# The master toctree document. 66master_doc = "index" 67 68# pylint: disable=line-too-long 69man_pages = [ 70 ( 71 "arpaname", 72 "arpaname", 73 "translate IP addresses to the corresponding ARPA names", 74 author, 75 1, 76 ), 77 ("ddns-confgen", "ddns-confgen", "ddns key generation tool", author, 8), 78 ("delv", "delv", "DNS lookup and validation utility", author, 1), 79 ("dig", "dig", "DNS lookup utility", author, 1), 80 ( 81 "dnssec-cds", 82 "dnssec-cds", 83 "change DS records for a child zone based on CDS/CDNSKEY", 84 author, 85 1, 86 ), 87 ("dnssec-dsfromkey", "dnssec-dsfromkey", "DNSSEC DS RR generation tool", author, 1), 88 ( 89 "dnssec-importkey", 90 "dnssec-importkey", 91 "import DNSKEY records from external systems so they can be managed", 92 author, 93 1, 94 ), 95 ( 96 "dnssec-keyfromlabel", 97 "dnssec-keyfromlabel", 98 "DNSSEC key generation tool", 99 author, 100 1, 101 ), 102 ("dnssec-keygen", "dnssec-keygen", "DNSSEC key generation tool", author, 1), 103 ( 104 "dnssec-ksr", 105 "dnssec-ksr", 106 "create signed key response (SKR) files for offline KSK setups", 107 author, 108 1, 109 ), 110 ( 111 "dnssec-revoke", 112 "dnssec-revoke", 113 "set the REVOKED bit on a DNSSEC key", 114 author, 115 1, 116 ), 117 ( 118 "dnssec-settime", 119 "dnssec-settime", 120 "set the key timing metadata for a DNSSEC key", 121 author, 122 1, 123 ), 124 ("dnssec-signzone", "dnssec-signzone", "DNSSEC zone signing tool", author, 1), 125 ("dnssec-verify", "dnssec-verify", "DNSSEC zone verification tool", author, 1), 126 ( 127 "dnstap-read", 128 "dnstap-read", 129 "print dnstap data in human-readable form", 130 author, 131 1, 132 ), 133 ( 134 "filter-aaaa", 135 "filter-aaaa", 136 "filter AAAA in DNS responses when A is present", 137 author, 138 8, 139 ), 140 ( 141 "filter-a", 142 "filter-a", 143 "filter A in DNS responses when AAAA is present", 144 author, 145 8, 146 ), 147 ("host", "host", "DNS lookup utility", author, 1), 148 ("mdig", "mdig", "DNS pipelined lookup utility", author, 1), 149 ( 150 "named-checkconf", 151 "named-checkconf", 152 "named configuration file syntax checking tool", 153 author, 154 1, 155 ), 156 ( 157 "named-checkzone", 158 "named-checkzone", 159 "zone file validity checking or converting tool", 160 author, 161 1, 162 ), 163 ( 164 "named-compilezone", 165 "named-compilezone", 166 "zone file validity checking or converting tool", 167 author, 168 1, 169 ), 170 ( 171 "named-journalprint", 172 "named-journalprint", 173 "print zone journal in human-readable form", 174 author, 175 1, 176 ), 177 ( 178 "named-nzd2nzf", 179 "named-nzd2nzf", 180 "convert an NZD database to NZF text format", 181 author, 182 1, 183 ), 184 ( 185 "named-rrchecker", 186 "named-rrchecker", 187 "syntax checker for individual DNS resource records", 188 author, 189 1, 190 ), 191 ("named.conf", "named.conf", "configuration file for **named**", author, 5), 192 ("named", "named", "Internet domain name server", author, 8), 193 ("nsec3hash", "nsec3hash", "generate NSEC3 hash", author, 1), 194 ("nslookup", "nslookup", "query Internet name servers interactively", author, 1), 195 ("nsupdate", "nsupdate", "dynamic DNS update utility", author, 1), 196 ("rndc-confgen", "rndc-confgen", "rndc key generation tool", author, 8), 197 ("rndc.conf", "rndc.conf", "rndc configuration file", author, 5), 198 ("rndc", "rndc", "name server control utility", author, 8), 199 ("tsig-keygen", "tsig-keygen", "TSIG key generation tool", author, 8), 200] 201 202# 203# The rst_epilog will be completely overwritten from the Makefile, 204# the definition here is provided purely for situations when 205# sphinx-build is run by hand. 206# 207rst_epilog = """ 208.. |rndc_conf| replace:: ``@sysconfdir@/rndc.conf`` 209.. |rndc_key| replace:: ``@sysconfdir@/rndc.key`` 210.. |named_conf| replace:: ``@sysconfdir@/named.conf`` 211.. |named_pid| replace:: ``@runstatedir@/named.pid`` 212.. |session_key| replace:: ``@runstatedir@/session.key`` 213""" 214 215 216def setup(app): 217 app.add_crossref_type("iscman", "iscman", "pair: %s; manual page") 218