diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-10-03 22:26:32 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-10-03 22:30:20 +0900 |
commit | 178c05b0597e144fdc2117c7b46ac15723a290e8 (patch) | |
tree | 1fd34a4def75ca2926d0e98240ece3864ef5f939 /sphinx/builders/manpage.py | |
parent | 88b81a06eb635a1596617f8971fa97a84c069e93 (diff) | |
download | sphinx-git-7996_man_make_section_directory.tar.gz |
Close #7996: manpage: Add man_make_section_directory7996_man_make_section_directory
Add a new config variable; man_make_section_directory to make a
section directory on build man page. During 3.x, it defaults to
False and will be changed to True on 4.0 release.
Diffstat (limited to 'sphinx/builders/manpage.py')
-rw-r--r-- | sphinx/builders/manpage.py | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 4166dece9..2a10ba62f 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -24,7 +24,7 @@ from sphinx.util import logging from sphinx.util import progress_message from sphinx.util.console import darkgreen # type: ignore from sphinx.util.nodes import inline_all_toctrees -from sphinx.util.osutil import make_filename_from_project +from sphinx.util.osutil import ensuredir, make_filename_from_project from sphinx.writers.manpage import ManualPageWriter, ManualPageTranslator @@ -80,7 +80,12 @@ class ManualPageBuilder(Builder): docsettings.authors = authors docsettings.section = section - targetname = '%s.%s' % (name, section) + if self.config.man_make_section_directory: + ensuredir(path.join(self.outdir, str(section))) + targetname = '%s/%s.%s' % (section, name, section) + else: + targetname = '%s.%s' % (name, section) + logger.info(darkgreen(targetname) + ' { ', nonl=True) destination = FileOutput( destination_path=path.join(self.outdir, targetname), @@ -115,6 +120,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.add_config_value('man_pages', default_man_pages, None) app.add_config_value('man_show_urls', False, None) + app.add_config_value('man_make_section_directory', False, None) return { 'version': 'builtin', |