Skip to content

Releases: Chilipp/autodocsumm

v0.2.4: Compatibility fixes for sphinx 4.0

09 May 12:03

Choose a tag to compare

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

15 Apr 11:56

Choose a tag to compare

This Release makes autodocsumm compatible with sphinx 3.4 and 3.5. See #42

v0.2.2: Patch for imported members and sorting

03 Dec 14:16

Choose a tag to compare

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

03 Dec 14:15

Choose a tag to compare

Patch for compatibility with python 3.5

v0.2.0: New directives and improved implementation

21 Aug 21:28
e0ab897

Choose a tag to compare

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-titles to 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

05 Mar 10:10

Choose a tag to compare

Minor fix with reference to #24 and #25 to not use the Autosummary.warning attribute.

v0.1.12: Compatibility fixes for sphinx 2.4.0

13 Feb 12:36

Choose a tag to compare

This patch makes autodocsumm compatible with sphinx 2.4.0.

v0.1.11: New option to disable autosummary nesting

20 Sep 13:28

Choose a tag to compare

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.

v0.1.10: Resolve bug for documenting instance attributes

06 May 11:15

Choose a tag to compare

This new releases solves the bug from #8 to properly name instance attributes in the autosummary table. Thanks @maeddlae for reporting.

v0.1.9: Better cython support

05 Apr 08:38

Choose a tag to compare

Thanks to @coldfix, autodocsumm has now better support for cython files and a better documentation.
See the PRs #4, #5 and #6.