Exclude empty submodule from docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Pdoc by default ignores private classes/functions (names with a leading underscore) in a module from the documentation. However if a module consists entirely of private classes and functions, the submodule still appears within the documentation, except it is simply empty (or displaying just the docstring if there is one). How can I automatically tell pdoc to ignore the module if it doesn't find anything public? I don't want this to be manual because modules change and at some point the module may have something public in it. And I have many modules like this
Additional info
- pdoc version: 0.10.0
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 reproducing the behavior with pdoc 0.10.0 using a module containing only private classes and functions, then trace how pdoc discovers and includes submodules. Done means entirely private submodules are omitted while modules containing public items remain documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100