Skip to main content

sphinx autosummary extension to properly format pandas or xarray accessors

Project description

sphinx-autosummary-accessors

https://github.com/xarray-contrib/sphinx-autosummary-accessors/workflows/CI/badge.svg?branch=master https://img.shields.io/badge/code%20style-black-000000.svg Documentation Status

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.multiply

Documentation

For more information and examples, see the documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-autosummary-accessors-2023.4.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file sphinx-autosummary-accessors-2023.4.0.tar.gz.

File metadata

File hashes

Hashes for sphinx-autosummary-accessors-2023.4.0.tar.gz
Algorithm Hash digest
SHA256 26f60f44dea2b4b487022921dfba6d773b4529b71afb7069cb97d4ceff0abab9
MD5 46508e80786803f53006d0989ccd16cb
BLAKE2b-256 75b9f37b5d3850d535707545d02165a2f34afdb8d51bb54f56d49a0a89a9f499

See more details on using hashes here.

File details

Details for the file sphinx_autosummary_accessors-2023.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autosummary_accessors-2023.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75ac537ce318e2cb104324f714c0260ee32483f117d8cd376dfaa3c5e949933d
MD5 6d0a2109efd68665ae1dd6d2d0779d66
BLAKE2b-256 7355b4a229b08c84ad3d752490b86eb1d5b77010e8991a1d3f5209e1d3c74ad5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page