Consider using argparse-manpage to build the man page from argparse
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 836
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
A new way to avoid duplicate maintenance of the man page would be to take advantage of argparse-manpage to automatically build the man page doc by introspection of the use of the argparse function.
Describe the solution you'd like
Get rid of the manually maintained doc/source/man/bandit.rst and replace with argparse-manpage to generate the manpage from argparse usage.
Describe alternatives you've considered
n/a
Additional context
https://github.com/praiskup/argparse-manpage
Love this idea? Give it a 👍. We prioritize fulfilling features with the most 👍.
Contributor guide
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 reviewing doc/source/man/bandit.rst and the argparse usage in the project, then compare the proposed argparse-manpage tool and its build integration. Done means the manually maintained man page is replaced by generated output and the documentation build produces the expected bandit man page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100