doc: disable man page section directories for Sphinx 4.0

Sphinx 4.0 creates man page section directories by default. Our "install-man" target expects a flat directory structure and is broken when man page section directories are used. Sphinx's `man_make_section_directory` option was introduced for this feature and defaults to `True` in Sphinx 4.0 and `False` in earlier versions. Disable the `man_make_section_directory` feature so that we can build uniformly across Sphinx versions. Closes git-cola#1141 Related-to: sphinx-doc/sphinx#7996 Signed-off-by: David Aguilar <davvid@gmail.com>
davvid · May 17, 2021 · 7cfb4c9 · 7cfb4c9
1 parent b086f46
commit 7cfb4c9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -37,6 +37,9 @@ Translations
 
 Fixes
 -----
+* `make install-man` was updated to support Sphinx 4.0.
+  (`#1141 <https://github.com/git-cola/git-cola/issues/1141>`_)
+
 * `git cola --help-commands` was updated for newer versions of argparse.
   (`#1133 <https://github.com/git-cola/git-cola/issues/1133>`_)
 

diff --git a/share/doc/git-cola/conf.py b/share/doc/git-cola/conf.py
@@ -59,6 +59,10 @@
     ('git-dag', 'git-dag', 'The sleek and powerful Git history browser', authors, '1'),
 ]
 
+# Sphinx 4.0 creates sub-directories for each man section.
+# Disable this feature for consistency across Sphinx versions.
+man_make_section_directory = False
+
 latex_documents = [
     (
         'index',