From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH] doc: improve config item labels in info output
Date: Fri, 1 Jul 2022 08:28:01 -0300 [thread overview]
Message-ID: <20220701112801.31971-1-david@tethera.net> (raw)
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
next reply other threads:[~2022-07-01 11:28 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-01 11:28 David Bremner [this message]
2022-07-01 12:00 ` [PATCH] doc: improve config item labels in info output David Bremner
2022-07-15 16:41 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220701112801.31971-1-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).