Skip to content

let user skip printing command description #9594

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

Merged
merged 4 commits into from
Sep 11, 2021
Merged

let user skip printing command description #9594

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26be2d1
skip empty description
hkuno Aug 30, 2021
d0e014b
Omit NAME section if blank description
hkuno Sep 6, 2021
5719299
Add a testcase for #9694
tk0miya Sep 11, 2021
fb141c3
Update CHANGES for PR #9594
tk0miya Sep 11, 2021
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
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 self._docinfo['subtitle']:
tmpl += "%(title)s \\- %(subtitle)s\n"
return tmpl % self._docinfo

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