upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-05-28 04:34:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
bind9/doc/arm
History
Petr Špaček 976aef030a Add table generator into Sphinx config extension 
New directive .. statementlist:: generates table of statements in a
the given domain (named.conf or rndc.conf). The table contains link to
definition, short description, and also list of tags.
Short description and tags have to be provided by user using optional
parameters. E.g.:

.. statement:: max-cache-size
   :tags: resolver, cache
   :short: Short description

.. statementlist:: is currently not parametrized.

This modification is based on Sphinx "tutorial" extension "TODO".
The main trick is to use placeholder node for .. statementlist:: and
replace it with table at later stage, when all source files were
processed and all cross-references can be resolved.

Beware, some details in Sphinx docs are not up-to-date, it's better
to read Sphinx and docutil sources.
2022-06-09 14:44:33 +02:00
..
_ext Add table generator into Sphinx config extension 2022-06-09 14:44:33 +02:00
_static ARM style change: render literals in black color 2022-06-02 17:13:19 +02:00
.gitattributes make git aware XML docbooks are only asset ARM needs to track 2020-01-13 11:08:18 +01:00
.gitignore Convert the documentation to Sphinx documentation format 2020-05-07 16:02:56 +02:00
advanced.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
build.inc.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
catz.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
chapter1.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
chapter2.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
chapter3.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
chapter4.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
chapter5.rst Add RPZ section to the ARM 2022-05-11 10:51:26 +02:00
chapter6.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
chapter7.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
chapter9.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
chapter10.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
conf.py Add Sphinx extension to help with ARM maintenance and cross-linking 2022-06-09 14:44:29 +02:00
config-auth.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
config-intro.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
config-resolve.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
dlz.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
dns-ops.inc.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
dns-security-overview.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-security-overview.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-servers.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-servers.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-tree.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-tree.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dnssec-guide.rst Minor DNSSEC guide tweaks 2022-05-11 10:51:26 +02:00
dnssec.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
dyndb.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
general.rst Hyperlink program names to their manual pages 2022-03-14 10:46:36 +01:00
history.rst Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
index.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
intro-dns-bind.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
intro-security.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
introduction.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
isc-logo.pdf Update ISC logo 2020-07-08 02:00:11 +00:00
logging-categories.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
Makefile.am Add Sphinx extension to help with ARM maintenance and cross-linking 2022-06-09 14:44:29 +02:00
managed-keys.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
manpages.rst In the ARM appendix, sort man page sections alphabetically 2022-03-10 20:13:22 +01:00
name-resolution.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
name-resolution.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
notes.rst BIND 9.19.1 2022-05-19 10:55:42 +02:00
pkcs11.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
platforms.inc.rst Add new ARM section Installing BIND 9 2022-05-11 10:51:26 +02:00
plugins.inc.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
primary-secondary.dia Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
primary-secondary.png Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
recursive-query.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
recursive-query.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
reference.rst Update signatures-refresh documentation 2022-05-31 15:45:14 +02:00
requirements.inc.rst Change title and add extra link to Resource Requirements in the ARM 2022-05-11 10:51:26 +02:00
requirements.txt Pin Sphinx related package versions to match ReadTheDocs and our CI 2022-04-27 14:33:45 +02:00
resolver-forward.dia Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
resolver-forward.png Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
rpz.inc.rst Add RPZ section to the ARM 2022-05-11 10:51:26 +02:00
security.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
sig0.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
tkey.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
troubleshooting.inc.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
tsig.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
zones.inc.rst Tweak zones.inc.rst now separated from Reference section 2022-05-11 10:51:26 +02:00