Extending your autodoc API docs with a summary
APACHE-2.0 License
Published by Chilipp 10 months ago
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.
Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.11...v0.2.12
Published by Chilipp over 1 year ago
Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.10...v0.2.11
Published by Chilipp almost 2 years ago
Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.9...v0.2.10
Published by Chilipp about 2 years ago
Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.8...v0.2.9
Published by Chilipp over 2 years ago
Full Changelog: https://github.com/Chilipp/autodocsumm/compare/v0.2.7...v0.2.8
Published by Chilipp about 3 years ago
This patch fixes some dependency definition (see #63, #64).
Published by Chilipp over 3 years ago
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.
Published by Chilipp over 3 years ago
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.
Published by Chilipp over 3 years ago
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
Published by Chilipp over 3 years ago
This Release makes autodocsumm compatible with sphinx 3.4 and 3.5. See https://github.com/Chilipp/autodocsumm/pull/42
Published by Chilipp almost 4 years ago
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.
Published by Chilipp almost 4 years ago
Published by Chilipp about 4 years ago
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 titlesFurthermore this release adds the .. autoclasssumm::
and .. automodulesumm::
directives to generate the autosummary tables anywhere in the documentation.
Published by Chilipp over 4 years ago
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.
Published by Chilipp over 4 years ago
This patch makes autodocsumm compatible with sphinx 2.4.0.
Published by Chilipp about 5 years ago
Thanks to the work by @piyushk in https://github.com/Chilipp/autodocsumm/issues/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.
Published by Chilipp over 5 years ago
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.
Published by Chilipp over 5 years ago
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.
Published by Chilipp over 5 years ago
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)
Published by Chilipp about 6 years ago