sphinx-argparse-cli
sphinx-argparse-cli copied to clipboard
Render CLI arguments (sub-commands friendly) defined by the argparse module.
updates: - [github.com/astral-sh/ruff-pre-commit: v0.4.2 → v0.4.3](https://github.com/astral-sh/ruff-pre-commit/compare/v0.4.2...v0.4.3)
```python group.add_argument( "--lib-name-path", help="Print the absolute path of interface library for given interface (VPI/VHPI/FLI) and simulator", nargs=2, metavar=("INTERFACE", "SIMULATOR"), ) ``` generates the following documentation  Only the first of...
With this input: ```rst .. sphinx_argparse_cli:: :module: my_prog.__main__ :func: build_parser :prog: my-prog ``` Toctree render as:  --- And with this input: ```rst ####################### my-prog - CLI interface ####################### .....
I am using the `:prog:` keyword for the ` sphinx_argparse_cli` directive but it appears that it only affects the first display of the command name. The main command name for...
The hard inclusion of `custom.css` (https://github.com/tox-dev/sphinx-argparse-cli/blob/4a542ff54cb34e6400fece0e320e37025d4514bf/src/sphinx_argparse_cli/__init__.py#L9) will lead to a 404 error when using different themes (e.g. sphinx_rtd_theme or sphinx_immaterial): 
pypa/build uses this extension with `:title: python -m build` and the first title shows up correctly as `python -m build` but the following ones are `python -m positional arguments` and...
updates: - [github.com/python-jsonschema/check-jsonschema: 0.29.0 → 0.29.1](https://github.com/python-jsonschema/check-jsonschema/compare/0.29.0...0.29.1) - [github.com/astral-sh/ruff-pre-commit: v0.5.4 → v0.5.5](https://github.com/astral-sh/ruff-pre-commit/compare/v0.5.4...v0.5.5)
```python test_selection = parser.add_argument_group("Test selection", "What should the script test") mutex_group.add_argument( "--test", "-t", metavar=("A", "B"), type=int, nargs=2, help="Select a specific A and B to run" ) ``` will display under...