sphinx-contrib / sphinx-contrib/autoprogram
Provide an option/directive to suppress/strip the title
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 24
- Avg merge
- 2h 15m
- Merged PRs (30d)
- 1
Description
I'm looking to use sphinxcontrib-autoprogram to embed the argparse help into a manpage of sorts.
But .. autoprogram:: adds a section head containing the :prog: name like so:
(It's the "aiosmtpd" line right under "SYNOPSIS". rst source code is as follows:)
SYNOPSIS
========
.. autoprogram:: aiosmtpd.main:_parser()
:prog: aiosmtpd
Please add an option/directive such as :notitle: to suppress this.
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 at the implementation of the autoprogram directive and trace how it emits the :prog: section heading. Add a directive option that suppresses that heading while preserving the generated argparse help, then verify that the example under SYNOPSIS renders without the aiosmtpd title.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100