sphinx-contrib / sphinx-contrib/autoprogram
Please provide a way to suppress certain options
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 24
- Avg merge
- 2h 15m
- Merged PRs (30d)
- 1
Description
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 from the sphinx documentation, but then it will also be removed from the CLI help, and I don't want that.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how autoprogram reads argparse options and generates Sphinx documentation. Determine where documentation-only suppression can be represented without changing CLI help behavior. Done means selected options, including the default --help option, can be omitted from the Sphinx output while remaining in CLI help.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100