We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Following 7f9757d, other submodules of the package not exported via __all__ are being included in a Modules: section.
__all__
Modules:
e.g. for:
foo/module2.py:
foo/module2.py
from foo import module1 __all__ = [ "Bar", ] class Bar: """Bars the bazes."""
module1 is getting included into a Modules table even though it is not exported.
module1
Modules
https://github.com/ringohoffman/mkdocstrings-python-minimum-reproducible-example/tree/main
git clone https://github.com/ringohoffman/mkdocstrings-python-minimum-reproducible-example cd mkdocstrings-python-minimum-reproducible-example python -m venv .venv . .venv/bin/activate pip install -r requirements.txt mkdocs build mkdocs serve
Then open the doc page for module2.
module2
I only expect the modules to be included in the Modules section if they are exported via __all__.
python -m mkdocstrings_handlers.python.debug # | xclip -selection clipboard - __System__: Linux-5.15.0-117-generic-x86_64-with-glibc2.31 - __Python__: cpython 3.10.15 (/home/matthew/.conda/envs/mkdocstrings/bin/python) - __Environment variables__: - __Installed packages__: - `mkdocs` v1.6.1 - `mkdocstrings` v0.26.2 - `mkdocstrings-python` v1.12.2 - `griffe` v1.5.1
The text was updated successfully, but these errors were encountered:
Thanks for the report @ringohoffman, looks like something that can be fixed/improved indeed.
Sorry, something went wrong.
Marking this as a bug. Only public objects should be added to auto-summaries.
fix: Actually check if a module is public when rendering auto-generat…
3bf55b2
…ed summary table for modules Issue-203: #203
pawamoy
No branches or pull requests
Description of the bug
Following 7f9757d, other submodules of the package not exported via
__all__
are being included in aModules:
section.e.g. for:
foo/module2.py
:module1
is getting included into aModules
table even though it is not exported.To Reproduce
https://github.com/ringohoffman/mkdocstrings-python-minimum-reproducible-example/tree/main
Then open the doc page for
module2
.Full traceback
Expected behavior
I only expect the modules to be included in the Modules section if they are exported via
__all__
.Environment information
The text was updated successfully, but these errors were encountered: