From: David Bremner <david@tethera.net>
Date: Fri, 1 Jul 2022 11:23:24 +0000 (-0300)
Subject: doc: improve config item labels in info output
X-Git-Tag: 0.37_rc0~43
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=7925481997878a0aea386d9f08ef2e3e24a00330

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.
---

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' )