sphinx-doc / sphinx-doc/sphinx-argparse
Format output as a table
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
I was wondering if it would be possible to add the option to format the argparse summary as a table such that the table contains the following or similar:
| argument | default | type | help/description |
|---|---|---|---|
| -- arg | "" | str | An example argument |
I like the current output, however, some projects I am working on have a lot of arguments and being able to output in a table format would clean up the documentation greatly.
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 extension entry point that generates the argparse summary and reviewing how the current output is produced. The work is done when an option allows the summary to render as a table with argument, default, type, and help or description columns without changing the existing format.
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