Skip to content
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.

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

fix: options formatter for manpages #50

Merged
merged 2 commits into from May 3, 2024
Merged

Conversation

fmoessbauer
Copy link

The "options" formatter for the manpage generation did not output any option, as the loop used a wrong key in the parser_info dictionary (likely a typo).

This patch fixes this, which results in correctly printed parser options in manpage mode.

The "options" formatter for the manpage generation did not output any
option, as the loop used a wrong key in the parser_info dictionary
(likely a typo).

This patch fixes this, which results in correctly printed parser options
in manpage mode.
@fmoessbauer
Copy link
Author

The CI failure is unrelated.

@ashb
Copy link
Collaborator

ashb commented May 3, 2024

Please add tests

@fmoessbauer
Copy link
Author

Please add tests

The whole man page generation is not tested (yet). Unfortunately I don't have the time to start this from scratch. If others are interested, I'm happy to review, though. My fix is a minimal drive-by fix while checking why many sphinx-generated manpages lack the parser options entries (found while working on siemens/kas@3f46848).

@ashb
Copy link
Collaborator

ashb commented May 3, 2024

Please add tests

The whole man page generation is not tested (yet). Unfortunately I don't have the time to start this from scratch. If others are interested, I'm happy to review, though. My fix is a minimal drive-by fix while checking why many sphinx-generated manpages lack the parser options entries (found while working on siemens/kas@3f46848).

Ack.

@ashb ashb merged commit c2f2766 into sphinx-doc:main May 3, 2024
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants