unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH] doc: improve config item labels in info output
@ 2022-07-01 11:28 David Bremner
  2022-07-01 12:00 ` David Bremner
  2022-07-15 16:41 ` David Bremner
  0 siblings, 2 replies; 3+ messages in thread
From: David Bremner @ 2022-07-01 11:28 UTC (permalink / raw)
  To: notmuch

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: improve config item labels in info output
  2022-07-01 11:28 [PATCH] doc: improve config item labels in info output David Bremner
@ 2022-07-01 12:00 ` David Bremner
  2022-07-15 16:41 ` David Bremner
  1 sibling, 0 replies; 3+ messages in thread
From: David Bremner @ 2022-07-01 12:00 UTC (permalink / raw)
  To: notmuch

David Bremner <david@tethera.net> writes:

> 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(-)
>
> -                        ref_nodeclass=docutils.nodes.generated)
> +                        ref_nodeclass=docutils.nodes.generated,
> +                        objname='config item' )
> -- 
> 2.35.2

This is the usual "naming is hard" dilemma. It might read nicer as
"Notmuch config item", but that is getting long. As far as I can tell
this is only relevant for info output.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: improve config item labels in info output
  2022-07-01 11:28 [PATCH] doc: improve config item labels in info output David Bremner
  2022-07-01 12:00 ` David Bremner
@ 2022-07-15 16:41 ` David Bremner
  1 sibling, 0 replies; 3+ messages in thread
From: David Bremner @ 2022-07-15 16:41 UTC (permalink / raw)
  To: notmuch

David Bremner <david@tethera.net> writes:

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

applied to master.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-07-15 16:42 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-01 11:28 [PATCH] doc: improve config item labels in info output David Bremner
2022-07-01 12:00 ` David Bremner
2022-07-15 16:41 ` David Bremner

Code repositories for project(s) associated with this inbox:

	notmuch.git.git (no URL configured)

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