]> git.ipfire.org Git - thirdparty/bind9.git/commit
Add table generator into Sphinx config extension
authorPetr Špaček <pspacek@isc.org>
Tue, 10 May 2022 12:50:34 +0000 (14:50 +0200)
committerPetr Špaček <pspacek@isc.org>
Thu, 9 Jun 2022 12:44:33 +0000 (14:44 +0200)
commit976aef030aa2ff6574c14340df43b39393bf920b
tree49ace663230d438d741f3a03ba6c6d3c63a3889e
parentb12606cebe700ce65cd245d2991a4c06eb5260ed
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.
doc/arm/_ext/iscconf.py
doc/arm/_ext/namedconf.py
doc/arm/_ext/rndcconf.py