]> git.cworth.org Git - notmuch/commitdiff
doc: fix man page build for Sphinx 4.x
authorJani Nikula <jani@nikula.org>
Tue, 18 May 2021 21:40:44 +0000 (00:40 +0300)
committerDavid Bremner <david@tethera.net>
Wed, 19 May 2021 11:26:22 +0000 (08:26 -0300)
Sphinx 4.0 changed the default value of man_make_section_directory
from False to True. We create the section directories and move the
files manually, so fix the immediate man build failure by disabling
the feature.

The Sphinx documentation on this [1] is confusing, and has the change
backwards. Git history says the default changed from False to True.

[1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_make_section_directory

doc/conf.py

index 1a5c217bb91e5299fbb2bc83f4e8d19bff466490..d0f7f66ce83ee8d639ec17869e407dd424053cee 100644 (file)
@@ -87,6 +87,8 @@ html_use_smartypants = False
 
 notmuch_authors = u'Carl Worth and many others'
 
+man_make_section_directory = False
+
 man_pages = [
     ('man1/notmuch', 'notmuch',
      u'thread-based email index, search, and tagging',