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

Named arguments value label is missing in generated documentation #81

Open
volans- opened this issue Oct 5, 2017 · 0 comments
Open

Comments

@volans-
Copy link

volans- commented Oct 5, 2017

When a named argument requires a value, the value label is not included into the generated documentation (I've checked in both HTML and manpage), making impossible to know if they need an argument or not.

As an example, if in the normal help message I have:

--foo         set the foo option
--bar VALUE   set the bar option to VALUE

I would expect the VALUE to be kept into the documentation, but it's not as far as I can tell.

Version used:

Sphinx==1.6.4
sphinx-argparse==0.2.1
``
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

No branches or pull requests

1 participant