sphinx-autosummary-accessors
sphinx autosummary extension to properly format pandas or xarray accessors
Decision gist · record as of 2026-08-14
Yes. If you maintain documentation for a library with pandas or xarray accessors, or custom accessor-style APIs, this extension eliminates template duplication and integrates cleanly with Sphinx. Low install friction, active maintenance, permissive license, and no known vulnerabilities make it a straightforward addition to your documentation build.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and configured in your documentation project.
- Low friction install with only two runtime dependencies (sphinx and packaging).
- Repository is active with recent commits and no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license is permissive; you can use this in commercial and private projects with minimal restrictions.
last release 2025-03-10 (522 days) · last repo commit 2026-08-10 · 16 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 121,159 downloads/mo, #11,991 on PyPI
Alternatives
Verify before relying
pip install sphinx-autosummary-accessors
# In conf.py:
import sphinx_autosummary_accessors
extensions = ["sphinx_autosummary_accessors"]
templates = ["_templates", sphinx_autosummary_accessors.templates_path]
# In .rst file:
.. autosummary::
:template: autosummary/accessor_method.rst
Example.test.multiply- Whether the extension works with Sphinx versions beyond those typically tested in the CI pipeline.
- Performance impact when documenting large numbers of accessors across multiple projects.
What it is and what it does
This package solves the problem of documenting accessor-style APIs (like `obj.accessor.method`) in Sphinx, which the standard `sphinx.ext.autosummary` extension doesn't handle well. It provides templates and extension logic adapted from pandas' own accessor documentation approach, allowing projects with pandas or xarray accessors—or custom accessors following that pattern—to generate proper summary and object pages without duplicating documentation infrastructure.
You add it to your Sphinx `conf.py` as an extension, point Sphinx to its templates directory, and then use the `accessor_method.rst` template in your `autosummary` directives. The extension is lightweight, depending only on sphinx and packaging, and is maintained actively with support for Python 3.9 through 3.13.
Use it for
- Document pandas DataFrame or Series accessors in a project's Sphinx documentation.
- Generate accessor method pages for xarray Dataset or DataArray custom accessors.
- Build documentation for a library that implements custom accessor-style APIs without reimplementing accessor templates.
- Avoid duplicating accessor documentation code across multiple projects in an organization.
- Automatically create summary pages for accessor methods alongside regular object documentation.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
If you maintain documentation for a library with pandas or xarray accessors, or custom accessor-style APIs, this extension eliminates template duplication and integrates cleanly with Sphinx. Low install friction, active maintenance, permissive license, and no known vulnerabilities make it a straightforward addition to your documentation build.
Install
sphinx-autosummary-accessors on PyPI
Before you install
Low friction install with only two runtime dependencies (sphinx and packaging). Repository is active with recent commits and no known vulnerabilities.
Requires Sphinx to be installed and configured in your documentation project.
License in practice
MIT license is permissive; you can use this in commercial and private projects with minimal restrictions.
Quickstart
pip install sphinx-autosummary-accessors
# In conf.py:
import sphinx_autosummary_accessors
extensions = ["sphinx_autosummary_accessors"]
templates = ["_templates", sphinx_autosummary_accessors.templates_path]
# In .rst file:
.. autosummary::
:template: autosummary/accessor_method.rst
Example.test.multiplyVerify before relying
- Whether the extension works with Sphinx versions beyond those typically tested in the CI pipeline.
- Performance impact when documenting large numbers of accessors across multiple projects.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinxpackaging |
| Maintenance | Actively maintained 522 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 121,159 / month, #11,991 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9 |
Evidence: sphinx_autosummary_accessors-2025.3.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx accessor documentation”
- sphinx-autosummary-accessorsA Sphinx extension that generates proper documentation for pandas or…
- alabasterAlabaster is a clean, responsive Sphinx theme for documentation that…
- sphinxcontrib-websupportProvides a Python API to integrate Sphinx-generated documentation…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also autodocsumm · pandas-flavor · cf-xarray · sphinx-remove-toctrees · sphinx-argparse · sphinx-jinja · sphinxcontrib-devhelp · sphinx-autodoc2 · sphinxcontrib-apidoc