Files
sphinx/tests/roots/test-ext-autosummary-module_all/index.rst
Clément Pinard 9299003d40 Autosummary: Extend `__all__` members to template rendering (#10811)
When ``False``, the ``autosummary_ignore_module_all`` option adds
members to the module's members entry that will be used for autodoc,
but otherwise ignores it. As such, if a class is available in the 
``__all__``, it won't be generated.

This commit aims to extend the ``__all__`` handling not only to
members, but also to corresponding attribute types (function,
classes, exceptions, modules)

The ``imported_members`` option is set to ``True`` if the object has
an ``__all__`` member and ``autosummary_ignore_module_all`` is ``False``
2023-04-06 00:02:37 +01:00

9 lines
154 B
ReStructuredText

test-ext-autosummary-module_all
===============================
.. autosummary::
:toctree: generated
:recursive:
autosummary_dummy_package_all