sphinx-doc / sphinx-doc/sphinx-argparse
Support for wrapping the usage declaration
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
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 hacked something to wrap my output, but I was wondering if this could be incorporated into the library as an option (maybe something like :width: 80 for 80 character width):
I'm happy to help if this is of interest and some pointers as to where to start could be provided.
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
No source file or test is named in the issue. Start by locating the extension's usage-section rendering entry point and its existing tests, then trace how the usage declaration is formatted. Done means an optional width setting wraps long usage output at the requested character width without changing the default output.
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