diff options
| author | David Bremner <david@tethera.net> | 2022-05-12 08:52:30 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2022-05-20 22:40:32 -0300 |
| commit | 306b7028d2288a3002cdbbcf8fd0973d8d969b84 (patch) | |
| tree | b804c505f7b1cc271c3e302f45fb64e3bf20a077 /doc/conf.py | |
| parent | 90a7c1af368a527700dcde9b0dcbd760afc7bd92 (diff) | |
doc: define and use semantic markup for configuration items
This makes sure each configuration item is cross referenceable without
extra markup, and also adds index entries.
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index e46e1d4e..6afeac06 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -200,3 +200,10 @@ texinfo_documents += [ x[2], # description 'Miscellaneous' # category ) for x in man_pages] + +def setup(app): + import docutils.nodes + # define nmconfig role and directive for config items. + app.add_object_type('nmconfig','nmconfig', + indextemplate='pair: configuration item; %s', + ref_nodeclass=docutils.nodes.generated) |