Add another level to API docs contents?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.5k
- Forks
- 631
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 10
Description
I have a feature request for the documentation.
Could another level be added to the table of contents for the API docs? I am having trouble navigating the new docs when I'm not able to easily see a listing of classes or jump to any particular one.
As an example, I would like to see what the various Geometry types are at a glance (https://shapely.readthedocs.io/en/latest/geometry.html), but only see this:
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 with the API documentation page geometry.html and inspect the documentation navigation that produces its table of contents. Verify how the Geometry types are currently presented and update the contents so individual classes can be seen or reached directly. Done means the API docs expose a usable listing of the Geometry types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100