]> git.cworth.org Git - notmuch/commit
doc: cross-reference notmuch man pages with actual links
authorJani Nikula <jani@nikula.org>
Fri, 21 May 2021 20:44:10 +0000 (23:44 +0300)
committerDavid Bremner <david@tethera.net>
Sat, 22 May 2021 19:38:56 +0000 (16:38 -0300)
commitff4e81ac57dee5a62f35093c2966f931a7b7580c
tree7b63cb0cfc64f9256ea7c1edbd3d58cdfc8fc85d
parent8675be1d307bc2df882107744641f6a7858e65ad
doc: cross-reference notmuch man pages with actual links

Add internal hyperlink targets for man pages and cross-reference them
using the any role reference. There are a number of alternatives to
accomplish this, but this seems like the combination that retains the
man page section number and the same boldface style in the man pages.

As a bonus, we get sanity checking on the links; for example
notmuch-search-terms.rst had a reference to notmuch-properties(1)
i.e. the wrong section.

The obvious semantic follow-up change would be to only have meaningful
"see also" references instead of having them all everywhere.
18 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
doc/man5/notmuch-hooks.rst
doc/man7/notmuch-properties.rst
doc/man7/notmuch-search-terms.rst