From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH 2/9] doc/conf.py: generate texinfo_documents list from man_pages list
Date: Sat, 5 Nov 2016 22:18:11 +0200 [thread overview]
Message-ID: <5c9c27a91e0084644222b0221ed00ead084ed93d.1478376896.git.jani@nikula.org> (raw)
In-Reply-To: <cover.1478376896.git.jani@nikula.org>
In-Reply-To: <cover.1478376896.git.jani@nikula.org>
No need to repeat mostly the same information twice in conf.py. We
probably want to have a corresponding texinfo document for all the man
pages. Python list comprehension to the rescue. (The reverse is not
true; we have a texinfo document for notmuch-emacs we don't want as a
man page.)
There should be no user visible changes.
---
doc/conf.py | 60 ++++++++++++------------------------------------------------
1 file changed, 12 insertions(+), 48 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index fce5a3afdfc2..aa02b9a8bb7b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -135,52 +135,16 @@ texinfo_documents = [
('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
u'Carl Worth and many others', 'notmuch-emacs',
'emacs based front-end for notmuch', 'Miscellaneous'),
-('man1/notmuch','notmuch',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch',
- 'thread-based email index, search, and tagging','Miscellaneous'),
-('man1/notmuch-address','notmuch-address',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-address',
- 'output addresses from matching messages','Miscellaneous'),
-('man1/notmuch-compact','notmuch-compact',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-compact',
- 'compact the notmuch database','Miscellaneous'),
-('man1/notmuch-config','notmuch-config',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-config',
- 'access notmuch configuration file','Miscellaneous'),
-('man1/notmuch-count','notmuch-count',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-count',
- 'count messages matching the given search terms','Miscellaneous'),
-('man1/notmuch-dump','notmuch-dump',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-dump',
- 'creates a plain-text dump of the tags of each message','Miscellaneous'),
-('man1/notmuch-emacs-mua','notmuch-emacs-mua',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-emacs-mua',
- u'send mail with notmuch and emacs','Miscellaneous'),
-('man5/notmuch-hooks','notmuch-hooks',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-hooks',
- 'hooks for notmuch','Miscellaneous'),
-('man1/notmuch-insert','notmuch-insert',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-insert',
- 'add a message to the maildir and notmuch database','Miscellaneous'),
-('man1/notmuch-new','notmuch-new',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-new',
- 'incorporate new mail into the notmuch database','Miscellaneous'),
-('man1/notmuch-reply','notmuch-reply',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-reply',
- 'constructs a reply template for a set of messages','Miscellaneous'),
-('man1/notmuch-restore','notmuch-restore',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-restore',
- 'restores the tags from the given file (see notmuch dump)','Miscellaneous'),
-('man1/notmuch-search','notmuch-search',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-search',
- 'search for messages matching the given search terms','Miscellaneous'),
-('man7/notmuch-search-terms','notmuch-search-terms',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-search-terms',
- 'syntax for notmuch queries','Miscellaneous'),
-('man1/notmuch-show','notmuch-show',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-show',
- 'show messages matching the given search terms','Miscellaneous'),
-('man1/notmuch-tag','notmuch-tag',u'notmuch Documentation',
- u'Carl Worth and many others', 'notmuch-tag',
- 'add/remove tags for all messages matching the search terms','Miscellaneous'),
]
+
+# generate texinfo list from man page list
+texinfo_documents += [
+ (
+ x[0], # source start file
+ x[1], # target name
+ u'notmuch Documentation', # title
+ x[3][0], # author
+ x[1], # dir menu entry
+ x[2], # description
+ 'Miscellaneous' # category
+ ) for x in man_pages]
--
2.1.4
next prev parent reply other threads:[~2016-11-05 20:20 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-05 20:18 [PATCH 0/9] doc: config and build improvements Jani Nikula
2016-11-05 20:18 ` [PATCH 1/9] doc/conf.py: add notmuch-emacs-mua to texinfo documents Jani Nikula
2016-11-05 20:18 ` Jani Nikula [this message]
2016-11-05 20:18 ` [PATCH 3/9] doc/conf.py: abstract notmuch authors Jani Nikula
2016-11-05 20:18 ` [PATCH 4/9] doc/conf.py: reindent, whitespace clean man page, texinfo lists Jani Nikula
2016-11-05 20:18 ` [PATCH 5/9] doc/conf.py: include command name in texinfo document title Jani Nikula
2016-11-05 20:18 ` [PATCH 6/9] doc: fix references in notmuch-emacs.rst Jani Nikula
2016-11-05 20:18 ` [PATCH 7/9] build: do not touch roff files after sphinx-build Jani Nikula
2016-11-05 20:18 ` [PATCH 8/9] build: generate man page list from source files, not conf.py Jani Nikula
2016-11-05 20:18 ` [PATCH 9/9] build: only install known man pages Jani Nikula
2016-11-16 17:36 ` [PATCH 0/9] doc: config and build improvements Tomi Ollila
2016-11-18 2:19 ` 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=5c9c27a91e0084644222b0221ed00ead084ed93d.1478376896.git.jani@nikula.org \
--to=jani@nikula.org \
--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).