bind9/doc
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
..
arm Add table generator into Sphinx config extension 2022-06-09 14:44:33 +02:00
design Remove obsolete notes on name compression 2022-06-01 13:00:40 +01:00
dev Enforce Python codestyle with black 2022-06-08 10:27:46 +02:00
dnssec-guide Minor DNSSEC guide tweaks 2022-05-11 10:51:26 +02:00
doxygen Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
man Auto-format Python files with black 2022-06-08 10:28:08 +02:00
misc Rename "hostname" to "remote-hostname" within "tls" 2022-05-03 17:15:43 +03:00
notes Add CHANGES and release note for [GL #2506] 2022-06-09 10:46:35 +00:00
Makefile.am Install man pages when sphinx-build tool is missing 2021-05-25 11:21:32 +02:00