unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH 0/5] doc: man page cleanup
@ 2021-05-21 20:44 Jani Nikula
  2021-05-21 20:44 ` [PATCH 1/5] doc: use manpage role references to external man pages Jani Nikula
                   ` (6 more replies)
  0 siblings, 7 replies; 12+ messages in thread
From: Jani Nikula @ 2021-05-21 20:44 UTC (permalink / raw)
  To: notmuch; +Cc: jani

I saw [1] and decided to give it some love. :)

Mostly this is all about adding html cross-references all over the place
while trying to keep the roff man pages roughly the same. Also updating
the man page rst becomes easier by setting a clean example.

BR,
Jani.



[1] https://notmuchmail.org/doc/latest/


Jani Nikula (5):
  doc: use manpage role references to external man pages
  doc: cross-reference notmuch man pages with actual links
  doc: use envvar directive and role for environment variables
  doc: use program and option directives to document options
  doc: example command-line option reference

 doc/conf.py                       |   5 +
 doc/man1/notmuch-address.rst      | 204 ++++++++--------
 doc/man1/notmuch-compact.rst      |  48 ++--
 doc/man1/notmuch-config.rst       | 147 ++++++------
 doc/man1/notmuch-count.rst        |  87 ++++---
 doc/man1/notmuch-dump.rst         | 176 +++++++-------
 doc/man1/notmuch-emacs-mua.rst    | 101 ++++----
 doc/man1/notmuch-insert.rst       | 128 +++++-----
 doc/man1/notmuch-new.rst          | 102 ++++----
 doc/man1/notmuch-reindex.rst      |  71 +++---
 doc/man1/notmuch-reply.rst        | 121 +++++-----
 doc/man1/notmuch-restore.rst      | 154 ++++++------
 doc/man1/notmuch-search.rst       | 264 +++++++++++----------
 doc/man1/notmuch-show.rst         | 380 ++++++++++++++++--------------
 doc/man1/notmuch-tag.rst          |  63 ++---
 doc/man1/notmuch.rst              | 139 ++++++-----
 doc/man5/notmuch-hooks.rst        |  54 +++--
 doc/man7/notmuch-properties.rst   |  36 +--
 doc/man7/notmuch-search-terms.rst |  50 ++--
 19 files changed, 1245 insertions(+), 1085 deletions(-)

-- 
2.30.2

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

end of thread, other threads:[~2021-05-23 11:13 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-21 20:44 [PATCH 0/5] doc: man page cleanup Jani Nikula
2021-05-21 20:44 ` [PATCH 1/5] doc: use manpage role references to external man pages Jani Nikula
2021-05-21 20:44 ` [PATCH 2/5] doc: cross-reference notmuch man pages with actual links Jani Nikula
2021-05-21 20:44 ` [PATCH 3/5] doc: use envvar directive and role for environment variables Jani Nikula
2021-05-21 20:44 ` [PATCH 4/5] doc: use program and option directives to document options Jani Nikula
2021-05-21 20:44 ` [PATCH 5/5] doc: example command-line option reference Jani Nikula
2021-05-22 19:51 ` [PATCH 0/5] doc: man page cleanup David Bremner
2021-05-22 22:15   ` Jani Nikula
2021-05-22 22:33     ` David Bremner
2021-05-22 22:56       ` Jani Nikula
2021-05-22 23:43         ` David Bremner
2021-05-23 11:13 ` David Bremner

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