notmuch/doc
Jani Nikula f2e2f2aa96 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.
2021-05-22 16:43:24 -03:00
..
man1 doc: use program and option directives to document options 2021-05-22 16:43:24 -03:00
man5 doc: cross-reference notmuch man pages with actual links 2021-05-22 16:38:56 -03:00
man7 doc: cross-reference notmuch man pages with actual links 2021-05-22 16:38:56 -03:00
.gitignore Use rooted paths in .gitignore files 2017-08-18 19:42:35 -03:00
conf.py doc: use manpage role references to external man pages 2021-05-22 09:56:52 -03:00
doxygen.cfg docs: drop deprecated doxygen TCL_SUBST flag 2021-01-09 11:25:43 -04:00
index.rst doc: add new python bindings to main documentation tree. 2020-07-15 08:37:11 -03:00
INSTALL doc: remove support for rst2man 2015-01-22 08:37:25 +01:00
Makefile doc: convert sphinx based docs 2014-03-09 10:41:08 -03:00
Makefile.local build/docs: move docstring prereq to file targets 2020-12-09 21:55:38 -04:00
notmuch-emacs.rst doc: fix variable name in documentation 2021-05-19 08:53:53 -03:00
python-bindings.rst doc: add new python bindings to main documentation tree. 2020-07-15 08:37:11 -03:00