Have methods and/or functions included in toctree.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
First, the numpydoc is a great resource. Thank you for the time you put into it!
Just a quick question: Is there a way to extend numpydoc to have visible toctrees to include functions and/or methods? Ideally I'm hoping to have the toc include all classes, methods, functions, etc and all hyperlinks to their definitions.
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 files or tests are named. Start by reviewing the numpydoc Sphinx extensions and how their generated documentation feeds a toctree. Define the expected behavior for including classes, methods, and functions, then verify that the resulting documentation exposes hyperlinks to each definition.
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