sphinx-doc / sphinx-doc/sphinx-argparse
Lower level headers for argument groups
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Currently argument groups have their headers generated at the same level as the broad "Positional Arguments" and "Named Arguments" headers, despite logically being below them hierarchically. To remedy this, it would be good if arguments groups were given a lower header depending on how deeply nested they are (or at least, be one header size lower so they are below the "Positional/Named Arguments" headers)
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 locating the argument-group header generation in the sphinx-argparse extension and inspect the produced Sphinx documentation for positional and named arguments. Done means nested argument groups use a lower header level than their enclosing "Positional Arguments" or "Named Arguments" headers.
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
- Mostly clear
- Newbie friendliness
- 45/100