Support for dynamically hiding or showing modules
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I currently use pdoc3 for my "developer documentation", i.e. the reference developers using my library goes to. That's a specific subset of all the modules I ship. Now, I would also like to provide a reference that also include all private modules, more suitable for anyone extending my library. Would it somehow be possible to normally just show some module, but via a flag or something show additional modules? I know the pages are statically generated, so I guess some JavaScript magic would be needed. Anyone see a chance to accomplish something like this at all (without having to generate two separate documentations)?
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 by reviewing how pdoc3 selects modules and produces static documentation. Define how a single generated documentation set could normally hide private modules while allowing an option to show them. Done means the same documentation can support both the public developer view and an expanded view without generating two separate sets.
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
- 35/100