Skip to content

Add man_skip_desc_subtitle option #9431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add man_skip_desc_subtitle option #9431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/usage/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,12 @@ General configuration

.. versionadded:: 1.7


.. confval:: man_skip_desc_subtitle

If true, Sphinx manpage builder will not generate a descriptive subtitle
for each man page. Default is ``False``.

.. confval:: nitpicky

If true, Sphinx will warn about *all* references where the target cannot be
Expand Down
1 change: 1 addition & 0 deletions sphinx/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ class Config:
'needs_sphinx': (None, None, [str]),
'needs_extensions': ({}, None, []),
'manpages_url': (None, 'env', []),
'man_skip_desc_subtitle': (False, 'env', []),
'nitpicky': (False, None, []),
'nitpick_ignore': ([], None, []),
'nitpick_ignore_regex': ([], None, []),
Expand Down
5 changes: 3 additions & 2 deletions sphinx/writers/manpage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,9 @@ def __init__(self, document: nodes.document, builder: Builder) -> None:
def header(self) -> str:
tmpl = (".TH \"%(title_upper)s\" \"%(manual_section)s\""
" \"%(date)s\" \"%(version)s\" \"%(manual_group)s\"\n"
".SH NAME\n"
"%(title)s \\- %(subtitle)s\n")
".SH NAME\n")
if (not self.config.man_skip_desc_subtitle):
tmpl += "%(title)s \\- %(subtitle)s\n"
return tmpl % self._docinfo

def visit_start_of_file(self, node: Element) -> None:
Expand Down