diff options
| author | Jani Nikula <jani@nikula.org> | 2021-05-21 23:44:09 +0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-05-22 09:56:52 -0300 |
| commit | 3baa61e0e58402bc50c5df529fcf669bf4b2facb (patch) | |
| tree | 4a0bb9880b67fadc7f0133970d2d5fbc7a28c89e /doc/conf.py | |
| parent | 702635d5f61729b5d0453f73d8eaa4bc6eb50ed4 (diff) | |
doc: use manpage role references to external man pages
Using manpage role references generates helpful links in html
documentation, while retaining the same boldface style in the man
pages.
The external man page site is configurable. The Debian manpage site
seems like a good fit for Notmuch.
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index d0f7f66c..4a4a3421 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -80,6 +80,11 @@ htmlhelp_basename = 'notmuchdoc' # Despite the name, this actually affects manual pages as well. html_use_smartypants = False +# See: +# - https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url +# - https://manpages.debian.org/ +manpages_url = 'https://manpages.debian.org/{page}.{section}.html' + # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples |