Using autodoc2_module_all_regexes to document public API, error for missing __all__ #77
Unanswered
dherrera1911
asked this question in
Q&A
Replies: 1 comment
-
I noticed that I can use the "exclude_files" option in |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
I want to use autodoc2 to document only the public API of my package. As said here, I am using the
autodoc2_module_all_regexes
configuration as follows:Then, in my package I have a subpackage called
datasets
with an__init__.py
file and aload.py
file. The__init__.py
file imports functions fromload.py
, defines some new functions and defines an__all__
variable. However, inload.py
I don't use an__all__
variable, since it's not imported by themy_package
and thus not public.In this case, I am getting the error
I have files like this that will also throw errors. My question is, is there a way to have autodoc2 realize that it shouldn't use
datasets/load.py
for the documentation? Or some way around having to define all in all the source files in the package?Beta Was this translation helpful? Give feedback.
All reactions