question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Submodule exclusion - differences between approaches

See original GitHub issue

Problem 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:

  1. Generate docs using pdoc foo; __all__ = ["bar"] in foo/__init__.py
  2. Generate docs using pdoc foo !foo.baz; no specified __all__ in foo/__init__.py
  3. Compare results

System Information

pdoc: 9.0.0
Python: 3.10.1
Platform: Windows-10-10.0.22000-SP0

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
mhilscommented, Feb 14, 2022

This is now fixed in pdoc 10, thanks again! 🍰

1reaction
mhilscommented, Jan 31, 2022

I’ve pushed experimental changes for approach 1) to main, see CHANGELOG.md. 😃

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found