aboutsummaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2022-07-01 08:23:24 -0300
committerDavid Bremner <david@tethera.net>2022-07-14 16:31:11 -0400
commit7925481997878a0aea386d9f08ef2e3e24a00330 (patch)
tree892904cf67cb7abecb1953bac0c0447262dfc3de /doc/conf.py
parent5e17495ab78937015de45704fff8300a37ca6508 (diff)
doc: improve config item labels in info output
Commit 306b7028d added the nmconfig role / directive. Unfortunately the default of using the directive name in texinfo output is pretty ugly, so attempt to make it more human readable by passing `objname` to add_object_type invocation.
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 7f94cbed..b60fefbc 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -218,4 +218,5 @@ def setup(app):
# define nmconfig role and directive for config items.
app.add_object_type('nmconfig','nmconfig',
indextemplate='pair: configuration item; %s',
- ref_nodeclass=docutils.nodes.generated)
+ ref_nodeclass=docutils.nodes.generated,
+ objname='config item' )