[PATCH] doc: improve config item labels in info output

Subject: [PATCH] doc: improve config item labels in info output

Date: Fri, 1 Jul 2022 08:28:01 -0300

To: notmuch@notmuchmail.org

Cc:

From: David Bremner

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 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/conf.py b/doc/conf.py
index f01c0058..70dd3059 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -210,4 +210,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' )
-- 
2.35.2

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: