Skip to main content

sphinx autosummary extension to properly format pandas or xarray accessors

Project description

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.

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 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. Once it is finished, using it should be (almost) as simple as adding "accessors" to extensions in the project’s conf.py.

Most of the code was adapted from pandas.

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-0.2.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: sphinx-autosummary-accessors-0.2.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for sphinx-autosummary-accessors-0.2.tar.gz
Algorithm Hash digest
SHA256 a4e819d5d6672b5bc47079c56a6b734f9879471c734dc6c22be4e1b5a781fcef
MD5 b1b1a1f1313b08bbc006f1408cd5c661
BLAKE2b-256 bd5b32a965d574207146fb81dd36a7915e24c3ec4a8a471640af200eab9ff988

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_autosummary_accessors-0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for sphinx_autosummary_accessors-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3278987974f035591ecc6e3ec263a2382d9bb6938027c7933f71387e64c51f25
MD5 a211f74be5b3c4e3a8f12a0fb1962db6
BLAKE2b-256 17b5004a9dc88e8715681802457f094ed355d690dc64966cbccb22ad0a404bfc

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