Install & Compatibility
Where this runs
tested against v0.2.15 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 92.4MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 5.2s · import 0.000s · 93MB
94MB installed
● package 94MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
autodocsumm
✓ extensions = [
'sphinx.ext.autodoc',
'autodocsumm'
]
autodocsumm is a Sphinx extension and is enabled by adding its name to the `extensions` list in `conf.py`, not via a direct Python import.
To enable `autodocsumm`, add `sphinx.ext.autodoc` and `autodocsumm` to the `extensions` list in your Sphinx `conf.py` file. Then, use the `:autosummary:` option with `autodoc` directives such as `automodule` or `autoclass` in your reStructuredText or MyST files to generate summary tables. You can also set `autodoc_default_options = {'autosummary': True}` in `conf.py` to activate it by default for all autodoc directives.
# In conf.py
extensions = [
'sphinx.ext.autodoc',
'autodocsumm'
]
# Optional: Make autosummary active by default for all autodoc directives
# autodoc_default_options = {'autosummary': True}
# In your .rst or .md file (e.g., module.rst)
..
.. automodule:: my_package.my_module
:members:
:autosummary:
.. autoclass:: my_package.my_module.MyClass
:members:
:autosummary:
Debug
Known issues
breakingautodocsumm frequently releases updates to maintain compatibility with new Sphinx versions. Using an `autodocsumm` version that is incompatible with your Sphinx installation can lead to build errors or unexpected documentation output.fixAlways ensure that your installed `autodocsumm` version explicitly supports your Sphinx major version. Check `autodocsumm`'s changelog or project page for specific Sphinx compatibility information (e.g., v0.2.15 supports Sphinx 9, v0.2.13 supports Sphinx 8).
affects: All versions; particularly when Sphinx is updated without a corresponding `autodocsumm` update.
breakingPrior to version 0.2.14, `autodocsumm` might encounter issues with `ObjectMember` related deprecations or removals in newer Sphinx versions, potentially causing documentation build failures.fixUpgrade `autodocsumm` to version 0.2.14 or later to address compatibility issues related to `ObjectMember` changes in Sphinx.
affects: <0.2.14 when used with newer Sphinx versions.
gotchaSimilar to `sphinx.ext.autodoc`, `autodocsumm` imports the Python modules it documents during the Sphinx build process. If your modules contain executable code with side effects outside of `if __name__ == '__main__'` blocks, this code will be executed when Sphinx builds the documentation.fixProtect any code with side effects in modules intended for documentation by placing it within an `if __name__ == '__main__'` block.
affects: All versions.
gotchaBy default, the autosummary tables generated by `autodocsumm` are typically placed at the end of the docstring sections for classes and methods. This might not be the desired visual placement for all users.fixTo customize the positioning of summary tables, use the `autoclasssumm` or `automodulesumm` directives directly inside class or module docstrings. For global sorting of sections within autosummary tables, use the `autodocsumm_section_sorter` configuration option (available since v0.2.12).
affects: All versions.
Upgrade
Version history
0.2.15latest on PyPI · released Mar 26, 2026
Audit
Dependencies
SphinxrequiredCore dependency as it is a Sphinx extension. Requires Sphinx version higher than 1.3.