sphinx-doc / sphinx-doc/sphinx-argparse
Named Arguments listing - two hrules with long names
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 38
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
This looks like a bug: when an argument name is long, then the generated html has a rule above and below the name. Normally, there is only a rule above the name.
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
Reproduce the generated HTML for an argparse option with a long argument name and compare it with the screenshot in the issue. Trace the Sphinx extension's HTML generation path; done means the long name has only the normal rule above it and the generated output is covered by a regression test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100