sphinx-doc / sphinx-doc/sphinx-argparse
Option to switch off Pos. Named Arguments as headers?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
I want to update sphinx-argparse to be able to use :nodescription:.
However, when I update the package I get something like this:
is there a way to get rid of these arguments, and keep it as it was before?
BTW Thanks for this great tool!
Copy from https://github.com/alex-rudakov/sphinx-argparse/issues/78
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
The issue mentions sphinx-argparse and the :nodescription: option, but names no files or tests. Start by reproducing the generated documentation and tracing where positional named arguments become headers; done means providing a way to suppress those headers while preserving the prior output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100