sphinx-doc / sphinx-doc/sphinx
Optionally add sub-section headers in automodule
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
When using automodule, I'd like to see every member listed in the local table of contents. Currently I don't think that's possible because new sections are not created for each member.
Describe the solution you'd like
A conf.py option or directive option that, when True, would create new sub-sections for each member when using automodule (and I suppose autoclass and autoexception too).
I looked into how nested_parse() works but couldn't figure out how to add new subsections. If someone could point me in the right direction, I'd be happy to create and submit a PR.
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 tracing how nested_parse() is used by automodule, then compare the related autoclass and autoexception directives. Done means a documented configuration or directive option creates sub-sections for each member so they appear in the local table of contents across the supported directives.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100