[PATCH 0/5] doc: man page cleanup

Subject: [PATCH 0/5] doc: man page cleanup

Date: Fri, 21 May 2021 23:44:08 +0300

To: notmuch@notmuchmail.org

Cc: jani@nikula.org

From: Jani Nikula


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
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: