Bug 7956 - options in man pages have incorrect style
Summary: options in man pages have incorrect style
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: LowPrio
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-07-01 08:49 CEST by Pierre Ossman
Modified: 2022-07-05 12:34 CEST (History)
0 users

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2022-07-01 08:49:11 CEST
The documented options for our various commands are currently not styled in accordance with the man pages style guide. It states that literal sections should have strong emphasis, placeholders should have regular emphasis, and everything else should be unstyled.

For the HTML and PDF backend, only the placeholder formatting is broken. The man backend, however, styles the entire syntax with strong emphasis.

Bug reported here:

https://github.com/sphinx-doc/sphinx/issues/10259

It seems the placeholder bit is getting fixed for 5.10 though:

https://github.com/sphinx-doc/sphinx/pull/10366

Note You need to log in before you can comment on or make changes to this bug.