]> git.cworth.org Git - notmuch/commitdiff
doc: improve config item labels in info output
authorDavid Bremner <david@tethera.net>
Fri, 1 Jul 2022 11:23:24 +0000 (08:23 -0300)
committerDavid Bremner <david@tethera.net>
Thu, 14 Jul 2022 20:31:11 +0000 (16:31 -0400)
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.

doc/conf.py

index 7f94cbed4d1c57da1d972e5225bce7dc36c74f8e..b60fefbc32a533cd44ed6c5c0d467684fb4b8597 100644 (file)
@@ -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' )