Semi-automatically populate __all__
in __init__.py
files
#337
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements one possible solution to the problem highlighted in #290. By specifying
__all__
in the relevant files, it makes explicit which modules and functions should be documented, so that only desired functions and modules are included. This also allows settingautosummary_imported_members = False
, which greatly speeds up building the documentation.It requires manual action when:
include_submodules
list in the parent module__init__.py
is added: must add the following boilerplate at the end of the file (number of dots before utils depends on the path):Please give feedback on the underlying mechanism. Is this an option we would be happy with, or should we rather try something else?