sphinx-contrib / sphinx-contrib/autoprogram
New option :label:
Open
Nobody has claimed this yet.
feature
- Dominant language
- Python
- Stars
- 48
- Forks
- 24
- Avg merge
- 2h 15m
- Merged PRs (30d)
- 1
Description
Please add a new option :label:, that adds a labels to all the created reST output:
if is_program:
yield '.. program:: ' + title
yield ''
+ if 'label' in self.options:
+ yield ''
+ yield '.. _%s:' % (self.options.get('label') + title).replace(" ", "-")
yield title
yield ('!' if is_subgroup else '?') * len(title)
yield ''
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 code that handles options and emits the created reST output, using the proposed :label: behavior as the specification. Verify that enabling the option produces a label anchor for each generated output, while output without the option remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100