autodocsumm

What's Changed

• Allow Sphinx >=8.0 and fix deprecations; allow Python 3.12; rework test workflow by @theOehrly in https://github.com/Chilipp/autodocsumm/pull/98

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.12...v0.2.13

This release implements a new configuration value autodocsumm_section_sorter thanks to @funkyfuture that allows a customization of the order of the autosummary tables, see https://github.com/Chilipp/autodocsumm/pull/93.

What's Changed

• small fix for tests by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/91
• fix docs by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/92
• An option to sort sections by @funkyfuture in https://github.com/Chilipp/autodocsumm/pull/93

New Contributors

• @funkyfuture made their first contribution in https://github.com/Chilipp/autodocsumm/pull/93

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.11...v0.2.12

What's Changed

• Support Sphinx 7 and Python 3.11 by @lafrech in https://github.com/Chilipp/autodocsumm/pull/86
• pin build of docs to sphinx<=7.0 by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/87

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.10...v0.2.11

What's Changed

• Allow Sphinx v6 by @lafrech in https://github.com/Chilipp/autodocsumm/pull/83
• install versioneer by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/84
• remove OrderedDict by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/85

New Contributors

• @lafrech made their first contribution in https://github.com/Chilipp/autodocsumm/pull/83

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.9...v0.2.10

What's Changed

• specify parser for BeautifulSoup by @Chilipp in https://github.com/Chilipp/autodocsumm/pull/76
• Allow Sphinx v5 by @EpicWink in https://github.com/Chilipp/autodocsumm/pull/79
• Declare project and pytest configuration in pyproject.toml by @EpicWink in https://github.com/Chilipp/autodocsumm/pull/80

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.8...v0.2.9

What's Changed

• Fix broken sphinx link in README by @cuspymd in https://github.com/Chilipp/autodocsumm/pull/68
• Fix: no links generated in summary table by @theOehrly in https://github.com/Chilipp/autodocsumm/pull/70
• improve tests by @Chilipp @theOehrly in https://github.com/Chilipp/autodocsumm/pull/71, https://github.com/Chilipp/autodocsumm/pull/72, https://github.com/Chilipp/autodocsumm/pull/73

New Contributors

• @cuspymd made their first contribution in https://github.com/Chilipp/autodocsumm/pull/68
• @theOehrly made their first contribution in https://github.com/Chilipp/autodocsumm/pull/71

Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.7...v0.2.8

This patch fixes some dependency definition (see #63, #64).

This patch resolves some minor deprecation warnings relevant for sphinx 4.0+, and uses the correct license classifier as the license changed to Apache-2.0 in v0.2.5.

This new release changes the license of autodocsumm (which was formerly licensed under GPL-2.0) to Apache-2.0 to make it better usable.

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 https://github.com/Chilipp/autodocsumm/issues/43

This Release makes autodocsumm compatible with sphinx 3.4 and 3.5. See https://github.com/Chilipp/autodocsumm/pull/42

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.

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.

Minor fix with reference to https://github.com/Chilipp/autodocsumm/issues/24 and https://github.com/Chilipp/autodocsumm/pull/25 to not use the Autosummary.warning attribute.

This patch makes autodocsumm compatible with sphinx 2.4.0.

Thanks to the work by @piyushk in https://github.com/Chilipp/autodocsumm/issues/19, autodocsumm now has a 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](https://autodocsumm.readthedocs.io/en/latest/examples.html#generating-a-summary-table-for-the-module-without-nesting).

This new releases solves the bug from https://github.com/Chilipp/autodocsumm/issues/8 to properly name instance attributes in the autosummary table. Thanks @maeddlae for reporting.

Thanks to @coldfix, autodocsumm has now better support for cython files and a better documentation. See the PRs https://github.com/Chilipp/autodocsumm/pull/4, https://github.com/Chilipp/autodocsumm/pull/5 and https://github.com/Chilipp/autodocsumm/pull/6.

This minor release includes some compatibility fixes for sphinx 2.0 (see PR https://github.com/Chilipp/autodocsumm/pull/1) and some fixes for *args and **kwargs in function signatures (see PR https://github.com/Chilipp/autodocsumm/pull/3)

A bug in the functionality of not documenting data (see autodocsumm.dont_document_data forced a rebuild of the entire docs always. This has been fixed.