sphinx-doc / sphinx-doc/sphinx
multi level view for python module index page
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.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
I would like to make the python module index more friendly to users by adding more levels of expanding and colliding the module API. currently, there is only one level and I'm not sure how to enable more levels
Describe the solution you'd like
A clear and concise description of what you want to happen.
I would like a solution like below
- GRAND PARENT API
- PARENT API
- CHILD API's
- PARENT API
in current solution it looks like
- GRAND PARENT API
- PARENT API
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
No source file, test, or entry point is identified in the issue. Start by locating the Python module index implementation and its current single-level expansion behavior, then determine how nested grandparent, parent, and child APIs should be represented and what tests would demonstrate the requested result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100