Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Sphinxify the command line documentation #252
Currently, the command line docs are rendered in the guide by piping the
Can we use some Sphinx features to improve this documentation, without having to duplicate the command line docs?
Of course, there are already Sphinx plugins that might be helpful:
sphinxcontrib.autoprogram renders the command line parameters nicely. However, it lumps all argument groups together which hides valuable context and makes the long list of options more difficult to read.
sphinx-argparse does render argument groups correctly, but uses tables for layout instead of the correct Sphinx roles. These tables overflow and have to be scrolled horizontally. Also, option value placeholders (metavars) are not rendered, which makes the phrasing of some option help messages difficult to read.
Due to these problems, neither of those plugins is currently a good replacement for the CLI documentation.