Homepage / page / bar with every function / class
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
Pdoc seems to be missing that thing a lot of API docs have where you can just see a big apahbetical / catagoires tree view list of every function / class
Proposal
An option to have this page be generated / for it to be put under the home page
Alternatives
It could also be something on the side bar
Additional context
I'm a noob so this already could be a thing, but kinda like this which is a big scrollable page and categories at the top (top level modules maybe)?
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, tests, or entry points are named in the issue. Start by reviewing how pdoc generates the homepage and sidebar, then compare the current output with the linked example. Done should mean there is a generated, alphabetical and categorized view of functions and classes, either on the homepage or in a sidebar.
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
- Mostly clear
- Newbie friendliness
- 32/100