-
Notifications
You must be signed in to change notification settings - Fork 40
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
Manpage: missing sections #82
Comments
Did you add the I had to add it like so:
Seems this is missing from the docs. |
@hstock, after adding the |
Currently not working on the project that needed this - but I'll get back to this for debian packaging of opentimestamps. (I am not directly involved in sphinx-argparse) |
I bumped into this bug while trying to generate tox's manpage using sphinx-argparse. I suspect the culprit is the usage of action groups in combination with a bug in the code. I think in this section of the code: |
I cannot find manpage sections listed in the source code at _construct_manpage_specific_structure() in the generated manpage. Am I missing some configuration by any chance?
The generated manpage has those sections:
While from the source code and usual best practices in manpage generation I was expecting to have:
SYNOPSIS
section with the synopsis of the commandDESCRIPTION
section with the description taken from the argparse parserOPTION
section with what is now in theNAMED ARGUMENTS
and maybePOSITIONAL ARGUMENTS
too? I'm not sure if usually the positional arguments are documented inside theDESCRIPTION
section.I'm not familiar with docutils library, so I'm not sure if those were meant to be subtitles inside the section, but the final results doesn't seems to follow best practices and the docstring in the code.
Versions used:
The text was updated successfully, but these errors were encountered: