sphinx-autosummary-accessors is a sphinx extension to properly document pandas or xarray style accessors using autosummary and autodoc.
autosummary is able to create summary and detail pages for objects
and their methods, but it doesn’t work well with accessor styled
properties and methods (
obj.accessor.attribute). pandas uses
autosummary templates to build its accessor documentation, which
xarray recently adopted by copying the templates and all related
To avoid even more duplicated code, and to make it easier for projects
to document their custom accessors, this package aims to make this
(almost) as simple as adding
"sphinx_autosummary_accessors" to the
Most of the code is adapted from pandas.
It is developed on github.