1# Copyright (C) Internet Systems Consortium, Inc. ("ISC") 2# 3# SPDX-License-Identifier: MPL-2.0 4# 5# This Source Code Form is subject to the terms of the Mozilla Public 6# License, v. 2.0. If a copy of the MPL was not distributed with this 7# file, you can obtain one at https://mozilla.org/MPL/2.0/. 8# 9# See the COPYRIGHT file distributed with this work for additional 10# information regarding copyright ownership. 11 12import datetime 13from docutils.parsers.rst import roles 14 15# 16# Configuration file for the Sphinx documentation builder. 17# 18# This file only contains a selection of the most common options. For a full 19# list see the documentation: 20# http://www.sphinx-doc.org/en/master/config 21 22# -- Path setup -------------------------------------------------------------- 23 24# If extensions (or modules to document with autodoc) are in another directory, 25# add these directories to sys.path here. If the directory is relative to the 26# documentation root, use os.path.abspath to make it absolute, like shown here. 27# 28# import os 29# import sys 30# sys.path.insert(0, os.path.abspath('.')) 31 32# -- Project information ----------------------------------------------------- 33 34project = "BIND 9" 35# pylint: disable=wrong-import-position 36year = datetime.datetime.now().year 37# pylint: disable=redefined-builtin 38copyright = "%d, Internet Systems Consortium" % year 39author = "Internet Systems Consortium" 40 41# -- General configuration --------------------------------------------------- 42 43# Build man pages directly in _build/man/, not in _build/man/<section>/. 44# This is what the shell code in Makefile.am expects. 45man_make_section_directory = False 46 47# Add any Sphinx extension module names here, as strings. They can be 48# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 49# ones. 50extensions = [] 51 52# Add any paths that contain templates here, relative to this directory. 53templates_path = ["../arm/_templates"] 54 55# List of patterns, relative to source directory, that match files and 56# directories to ignore when looking for source files. 57# This pattern also affects html_static_path and html_extra_path. 58exclude_patterns = [ 59 "_build", 60 "Thumbs.db", 61 ".DS_Store", 62] 63 64# The master toctree document. 65master_doc = "index" 66 67# pylint: disable=line-too-long 68man_pages = [ 69 ( 70 "arpaname", 71 "arpaname", 72 "translate IP addresses to the corresponding ARPA names", 73 author, 74 1, 75 ), 76 ("ddns-confgen", "ddns-confgen", "ddns key generation tool", author, 8), 77 ("delv", "delv", "DNS lookup and validation utility", author, 1), 78 ("dig", "dig", "DNS lookup utility", author, 1), 79 ( 80 "dnssec-cds", 81 "dnssec-cds", 82 "change DS records for a child zone based on CDS/CDNSKEY", 83 author, 84 8, 85 ), 86 ( 87 "dnssec-checkds", 88 "dnssec-checkds", 89 "DNSSEC delegation consistency checking tool", 90 author, 91 8, 92 ), 93 ( 94 "dnssec-coverage", 95 "dnssec-coverage", 96 "checks future DNSKEY coverage for a zone", 97 author, 98 8, 99 ), 100 ("dnssec-dsfromkey", "dnssec-dsfromkey", "DNSSEC DS RR generation tool", author, 8), 101 ( 102 "dnssec-importkey", 103 "dnssec-importkey", 104 "import DNSKEY records from external systems so they can be managed", 105 author, 106 8, 107 ), 108 ( 109 "dnssec-keyfromlabel", 110 "dnssec-keyfromlabel", 111 "DNSSEC key generation tool", 112 author, 113 8, 114 ), 115 ("dnssec-keygen", "dnssec-keygen", "DNSSEC key generation tool", author, 8), 116 ( 117 "dnssec-keymgr", 118 "dnssec-keymgr", 119 "ensure correct DNSKEY coverage based on a defined policy", 120 author, 121 8, 122 ), 123 ( 124 "dnssec-revoke", 125 "dnssec-revoke", 126 "set the REVOKED bit on a DNSSEC key", 127 author, 128 8, 129 ), 130 ( 131 "dnssec-settime", 132 "dnssec-settime", 133 "set the key timing metadata for a DNSSEC key", 134 author, 135 8, 136 ), 137 ("dnssec-signzone", "dnssec-signzone", "DNSSEC zone signing tool", author, 8), 138 ("dnssec-verify", "dnssec-verify", "DNSSEC zone verification tool", author, 8), 139 ( 140 "dnstap-read", 141 "dnstap-read", 142 "print dnstap data in human-readable form", 143 author, 144 1, 145 ), 146 ( 147 "filter-aaaa", 148 "filter-aaaa", 149 "filter AAAA in DNS responses when A is present", 150 author, 151 8, 152 ), 153 ("host", "host", "DNS lookup utility", author, 1), 154 ("mdig", "mdig", "DNS pipelined lookup utility", author, 1), 155 ( 156 "named-checkconf", 157 "named-checkconf", 158 "named configuration file syntax checking tool", 159 author, 160 8, 161 ), 162 ( 163 "named-checkzone", 164 "named-checkzone", 165 "zone file validity checking or converting tool", 166 author, 167 8, 168 ), 169 ( 170 "named-compilezone", 171 "named-compilezone", 172 "zone file validity checking or converting tool", 173 author, 174 8, 175 ), 176 ( 177 "named-journalprint", 178 "named-journalprint", 179 "print zone journal in human-readable form", 180 author, 181 8, 182 ), 183 ( 184 "named-nzd2nzf", 185 "named-nzd2nzf", 186 "convert an NZD database to NZF text format", 187 author, 188 8, 189 ), 190 ( 191 "named-rrchecker", 192 "named-rrchecker", 193 "syntax checker for individual DNS resource records", 194 author, 195 1, 196 ), 197 ("named.conf", "named.conf", "configuration file for **named**", author, 5), 198 ("named", "named", "Internet domain name server", author, 8), 199 ("nsec3hash", "nsec3hash", "generate NSEC3 hash", author, 8), 200 ("nslookup", "nslookup", "query Internet name servers interactively", author, 1), 201 ("nsupdate", "nsupdate", "dynamic DNS update utility", author, 1), 202 ("pkcs11-destroy", "pkcs11-destroy", "destroy PKCS#11 objects", author, 8), 203 ("pkcs11-keygen", "pkcs11-keygen", "generate keys on a PKCS#11 device", author, 8), 204 ("pkcs11-list", "pkcs11-list", "list PKCS#11 objects", author, 8), 205 ("pkcs11-tokens", "pkcs11-tokens", "list PKCS#11 available tokens", author, 8), 206 ("rndc-confgen", "rndc-confgen", "rndc key generation tool", author, 8), 207 ("rndc.conf", "rndc.conf", "rndc configuration file", author, 5), 208 ("rndc", "rndc", "name server control utility", author, 8), 209 ("tsig-keygen", "tsig-keygen", "TSIG key generation tool", author, 8), 210] 211 212 213def setup(app): 214 app.add_crossref_type("iscman", "iscman", "pair: %s; manual page") 215 # ignore :option: references to simplify doc backports to v9_16 branch 216 app.add_role_to_domain("std", "option", roles.code_role) 217