readthedocs / readthedocs/sphinx-autoapi
How to sort TOC entries
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Hi,
I am struggling to sort the entries of the .. toctree:: in documentation generated with autoapi. I have one <submodule>.piy sutbfile for each of my project's submodule and it seems they are shown in the TOC in the order they appear rather than in alphabetical order.
I haven't found a way to sort those entries from the available documentation. Am I missing something?
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
No source file or test is named. Start by reading the AutoAPI documentation for toctree generation and entry ordering, then inspect how generated submodule files are collected; done means documenting a supported sorting approach or clearly identifying that none exists.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100