sphinx-doc / sphinx-doc/sphinx
man page writer could highlight .. rubric
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
This feature request was reported as a subpart of bug report #6331; the bug has been fixed but the feature request remains.
Is your feature request related to a problem? Please describe.
The man page writer doesn't highlight .. rubric::, even though it highlights the (somewhat) similar .. topic::.
Example:
$ sphinx-quickstart -q -pfoo -afoo
edit index.rst to add
.. rubric:: Rubric
.. topic:: Topic
This.
then
$ make man
$ man _build/man/foo.1
Describe the solution you'd like
.. rubric:: get highlighted by the man page writer, e.g. like .. topic::.
Describe alternatives you've considered
n/a
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
Reproduce the example with sphinx-quickstart, index.rst, make man, and man _build/man/foo.1. Compare how the man page writer renders .. topic:: and .. rubric::, then make the rubric output highlighted in the same way and verify the generated man page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100