readthedocs / readthedocs/sphinx-autoapi
`add_module_names = False` doesn't affect toctrees, only the body
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Thanks for this great extension. Just a quick question: Is there a way to remove module name from toctree entries, similar to what's rendered in the body? add_module_names = False seems to only affect the body rendering. Thanks!
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 tracing how the add_module_names setting is applied to body output and toctree entries, then compare the two rendering paths. Done means setting add_module_names to False also removes module names from toctree entries while preserving the existing body behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100