Submodule exclusion - differences between approaches
See original GitHub issueProblem Description
Despite what the documentation suggests, when it comes to submodule exclusion specifying __all__
does not have the same effect as passing negative regular expression !patterns as part of the module specification.
Specifically, specifing submodules in __all__
will render the modules’ docstrings, as well as generate the API Documentation
section; the same is not true when using the alternative approach.
I uderstand the difference in approaches, just thought it would be worth pointing out so as to make the documentation clearer. Related: Perhaps allow for documentation specific issues? They don’t really fit in with the bugs/enhancement options currently in place.
Steps to reproduce the behavior:
- Generate docs using
pdoc foo
;__all__ = ["bar"]
infoo/__init__.py
- Generate docs using
pdoc foo !foo.baz
; no specified__all__
infoo/__init__.py
- Compare results
System Information
pdoc: 9.0.0
Python: 3.10.1
Platform: Windows-10-10.0.22000-SP0
Issue Analytics
- State:
- Created 2 years ago
- Comments:6 (4 by maintainers)
Top Results From Across the Web
Exclude submodule of a submodule - git - Stack Overflow
Now when I clone my repo, and run git submodule update --init --recursive , in order to build it on a CI server,...
Read more >365Git — Three ways of excluding files.
There are three types of exclude files; from highest to lowest order of precedence ... Changing The URL Of An Upstream Submodule Repository....
Read more >git Submodules Explained | Mark's Blog
Submodules in git are commonly misunderstood in various ways, ... A submodule in a git repository is like a sub-directory which is really...
Read more >Selectively clone Git submodules -- a useful feature?
AFAIK there is no way to selectively clone only a subset of the submodules with the standard command line interface. I wonder if...
Read more >Using Git submodules with GitLab CI/CD
Use Git submodules to keep a Git repository as a subdirectory of another Git repository. You can clone another repository into your project...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
This is now fixed in pdoc 10, thanks again! 🍰
I’ve pushed experimental changes for approach 1) to main, see CHANGELOG.md. 😃