From 7cfb4c9d6bc01055ecce7f98db71eac16fa13932 Mon Sep 17 00:00:00 2001 From: David Aguilar Date: Sun, 16 May 2021 17:46:31 -0700 Subject: [PATCH] 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 #1141 Related-to: https://github.com/sphinx-doc/sphinx/issues/7996 Signed-off-by: David Aguilar --- CHANGES.rst | 3 +++ share/doc/git-cola/conf.py | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index d3ece6866..7650bf622 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -37,6 +37,9 @@ Translations Fixes ----- +* `make install-man` was updated to support Sphinx 4.0. + (`#1141 `_) + * `git cola --help-commands` was updated for newer versions of argparse. (`#1133 `_) diff --git a/share/doc/git-cola/conf.py b/share/doc/git-cola/conf.py index f3caca714..ac5be2ee6 100644 --- 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',