]> git.cworth.org Git - notmuch/commit - doc/man1/notmuch-address.rst
doc: use program and option directives to document options
authorJani Nikula <jani@nikula.org>
Fri, 21 May 2021 20:44:12 +0000 (23:44 +0300)
committerDavid Bremner <david@tethera.net>
Sat, 22 May 2021 19:43:24 +0000 (16:43 -0300)
commitf2e2f2aa96cb0d40c6fb85cde2ab82380c367485
tree62db8cfc77351a8b441b8648c256384b273d2ee4
parent574b2436eeabf60c930ba227931ee87b0b151a65
doc: use program and option directives to document options

Use the program and option directives to document the subcommand
options. This unifies a lot of option documentation throughout.

This also makes it possible to reference options with :option:`--foo`
(within .. program::) or :option:`subcommand --foo` (globally). This
is left for later work.

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program

Note: There is a lot of indentation change, but intentionally there is
no reflow. Using 'git diff -w' or 'git show -w' to ignore white space
changes makes this a very easy change to review.
15 files changed:
doc/man1/notmuch-address.rst
doc/man1/notmuch-compact.rst
doc/man1/notmuch-config.rst
doc/man1/notmuch-count.rst
doc/man1/notmuch-dump.rst
doc/man1/notmuch-emacs-mua.rst
doc/man1/notmuch-insert.rst
doc/man1/notmuch-new.rst
doc/man1/notmuch-reindex.rst
doc/man1/notmuch-reply.rst
doc/man1/notmuch-restore.rst
doc/man1/notmuch-search.rst
doc/man1/notmuch-show.rst
doc/man1/notmuch-tag.rst
doc/man1/notmuch.rst