sphinx-autosummary-accessors
A sphinx extension to properly document pandas or xarray accessors.
sphinx.ext.autosummary is able to create summary and object pages for objects and their methods, but it doesn’t work well with accessor styled properties and methods (obj.accessor.attribute). pandas has accessor documentation built using sphinx.ext.autosummary templates, which xarray recently adopted by copying the templates and all related code.
To avoid even more duplicated code, and to make it easier for projects to document their custom accessors, this project aims to provide this functionality by way of a sphinx extension.
Most of the code was adapted from pandas.
Usage
Using it should be as simple as adding
import sphinx_autosummary_accessors
extensions = [
...,
"sphinx_autosummary_accessors",
]
templates = ["_templates", ..., sphinx_autosummary_accessors.templates_path]to your conf.py and using the appropriate template:
.. autosummary::
:template: autosummary/accessor_method.rst
Example.test.multiplyDocumentation
For more information and examples, see the documentation.
Metadata
Release files for sphinx-autosummary-accessors 2026.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_autosummary_accessors-2026.10.0.tar.gz | 46.4 kB | With provenance | Details for sphinx_autosummary_accessors-2026.10.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_autosummary_accessors-2026.10.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_autosummary_accessors-2026.10.0-py3-none-any.whl |
Total release size: 56.5 kB
Release files / sphinx_autosummary_accessors-2026.10.0.tar.gz
| Download URL | sphinx_autosummary_accessors-2026.10.0.tar.gz |
|---|---|
| Size | 46.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fec7eebe8f5110e9c2c12a26e9bf098a5b15a26688be2d6151d7c5718daf50c4
|
|
BLAKE2b-256 checksum How to use checksums |
1e45dfa347cf3b18aac7b8b90cb27d3c243089f8831934de725d7523836563bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / sphinx_autosummary_accessors-2026.10.0-py3-none-any.whl
| Download URL | sphinx_autosummary_accessors-2026.10.0-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b61964f4e3e57274fb16cd750e68b7108ceb9ce193a3d4925565cf6fcdbf4fb7
|
|
BLAKE2b-256 checksum How to use checksums |
7426d19ff69f8abca5f59900db1ad7a7329de3b80e69637c2c55f8df5edbd0f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logSecurity for sphinx-autosummary-accessors 2026.10.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_autosummary_accessors-2026.10.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
