{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that generates proper documentation for pandas or xarray accessor-style properties and methods, avoiding code duplication across projects with custom accessors.","skillfed_tags":["sphinx-extension","documentation-generation"],"use_cases":["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."],"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\u2014or custom accessors following that pattern\u2014to generate proper summary and object pages without duplicating documentation infrastructure.\n\nYou 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.","worth_installing":"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."},"id":"sphinx-autosummary-accessors","links":{"html":"https://skillfed.io/packages/sphinx-autosummary-accessors","md":"https://skillfed.io/packages/sphinx-autosummary-accessors.md","pypi":"https://pypi.org/project/sphinx-autosummary-accessors/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-03-10","license_spdx":null,"license_treatment":"permissive","name":"sphinx-autosummary-accessors","python_support":"supports_current","summary":"sphinx autosummary extension to properly format pandas or xarray accessors"},"popularity":{"monthly_downloads":121159,"position":11991,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"2025.3.1"}