sphinx-contrib / sphinx-contrib/openapi
[feature request]: table of contents of paths/methods
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
Generating a table of contents with direct links to the included paths/methods would be helpful when the generated documentation is long (e.g. when there are many paths/methods, when several or long examples are included).
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 by locating the Sphinx extension's generated documentation entry point and the code that emits paths, methods, and examples. Define the work as adding a table of contents with direct links to the included paths and methods, then verify it on a long generated document containing many paths or examples.
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