autoprogram
autoprogram copied to clipboard
sphinx-contrib
Documenting CLI programs
Is it possible to output multiple manpages/html pages eg for commands with multiple subcommands and a lot of options? I'd like to have the main command in a page and...
As highlighted in #42, the expectations around what versions of Python this project supports are unclear. These should be documented, and every supported version should be tested in CI.
Usually I describe in short what a subcommand does by putting a text into a subparsers help argument. Argparser renders it like this: ``` $ disco -h usage: disco [-h]...
How does autoprogram compare against argdoc? https://github.com/sphinx-contrib/argdoc It looks like argdoc is not supported anymore and the recommended way to go is autoprogram? Thanks!
Hi I just realised that #21 or at least something similiar appears to be still an issue in generated manpages. Not sure if it is related at all, just sounds...
I'm using autoprogram to document a Python script that uses argparse with a custom Formatter class that inherits from argparse.ArgumentDefaultsHelpFormatter and argparse.RawDescriptionHelpFormatter. The RST string returned by the render_rst() function...
Hi, When using autoprogram, I always get some options included that I'd rather remove. The most obvious one being the default `--help` option. I could use `argparse.SUPPRESS` to remove it...
I'm looking to use `sphinxcontrib-autoprogram` to embed the argparse help into a manpage of sorts. But `.. autoprogram::` adds a section head containing the `:prog:` name like so: 