sphinx-argparse
sphinx-argparse copied to clipboard
ashb
Sphinx extension that automatically document argparse commands and options
**Problem description:** The rendered documentation of a certain command looks as follows: ``` sample apply [-h] [-r] [--tree] [--dry] [--force] path default_string Positional Arguments path Specify path to provision script....
- Add optional command index and optional commands-by-group index. - Optionally, print fully-qualified subcommand name in title. - Support commands:command role for intersphinx. - Prefer fully-qualified HREF targets: * Use...
I am trying to use this with a CLI that has a lot of configuration options, so when I render the usage section it requires a lot of horizontal scrolling:...
I have a function in a file which parses arguments: ``` def get_args(): #Set up parser and top level args parser = argparse.ArgumentParser(description='ASCENT: Automated Simulations to Characterize Electrical Nerve Thresholds')...
Great extension. It's used by my team and I have suggestions for some significant revision. I have _an implementation_ of all the following items, but I'm cataloging them to find...
This looks like a bug: when an argument name is long, then the generated html has a rule above and below the name. Normally, there is only a rule above...
### Problem When writing arguments using `argparse`, one often includes the type of the variable (e.g., `str`, `np.int32`). However as far as I can tell, when using sphinx-argparse this type...
Importing 3rd party libraries/modules, requires those be mocked to avoid raising `ModuleNotFoundError` when using sphinx. One possibility is to use mock.Mock() as suggested in https://github.com/alex-rudakov/sphinx-argparse/issues/87 or https://github.com/readthedocs/readthedocs.org/issues/4855. One caveat is...
I want to update sphinx-argparse to be able to use `:nodescription:`. However, when I update the package I get something like this: ...
