Releases: Chilipp/autodocsumm
v0.2.4: Compatibility fixes for sphinx 4.0
This patch makes autodocsumm compatible with sphinx 4.0 and from now on requires python>=3.6.
Additionally, we implemented support for the :nosignatures: option, see #43
v0.2.3: Compatibility fixes for sphinx 3.4 and 3.5
This Release makes autodocsumm compatible with sphinx 3.4 and 3.5. See #42
v0.2.2: Patch for imported members and sorting
This release fixes a bug that included imported members in the
autosummary table (see #32, #33) and includes the sorting bysource
(#34). We also dropped the dependency on six (#35).
Thanks to the input by @bouweandela, @felixchenier, @btjanaka and
@sirosen.
v0.2.1: Patch for compatibility with python 3.5
Patch for compatibility with python 3.5
v0.2.0: New directives and improved implementation
This release improves the implementation of autodocsumm by generating the tables using the .. autosummary directive. This solves multiple ambiguities within the package. We furthermore add new options:
:autosummary-sections:to select specific sections to generate the autosummary tables for:autosummary-no-titlesto omit section titles
Furthermore this release adds the .. autoclasssumm:: and .. automodulesumm:: directives to generate the autosummary tables anywhere in the documentation.
v0.1.13: Fix deprecated Autosummary.warning
v0.1.12: Compatibility fixes for sphinx 2.4.0
This patch makes autodocsumm compatible with sphinx 2.4.0.
v0.1.11: New option to disable autosummary nesting
Thanks to the work by @piyushk in #19, autodocsumm now has a :autosummary-no-nesting: option to disable the generation of autosummary tables for the classes in a module.
As such,
.. automodule:: module
:autosummary:
:members:
:autosummary-no-nesting:
will generate an autosummary table for the specified module, but not for the members (i.e. classes) in the module.
See the docs for an example.