sphinx
sphinx copied to clipboard
extend __all__ members to template rendering
Fixes #10809
- the option
autosummary_ignore_module_allwhen set toFalseadds members to module's members entry that will be used for autodoc, but otherwise it ignores it. As such, if a class is available in the__all__, it won't be generated. - This commit aims at extending the
__all__handling not only to members, but also to corresponding attribute types (functions, classes, exceptions, modules) - In short, the
imported_membersoption is set toTrueif the object has__all__member and autosummary is set to haveautosummary_ignore_module_allset to False
See an example repo where the behaviour is changed : https://github.com/ClementPinard/sphinx_autosummary_bug_example
this PR is (at least initially) just for illustration and discussion purpose. tests where not checked
Feature or Bugfix
- Feature
- Bugfix
A mix of both
Detail
- See issue #10809