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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: sphinx-autosummary-accessors-0.1.2.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20200616 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

File hashes

Hashes for sphinx-autosummary-accessors-0.1.2.tar.gz
Algorithm Hash digest
SHA256 808c41542fffdf5ead6e74a291b4294191adc78d03fc53b945bf7c5ece299d27
MD5 d380b0dbcb9fbe82c694e30743fc7216
BLAKE2b-256 c0c86acf47c7ec1fb9ae27b4e6790bd1ee83e1d36f61c73bf7930e59df11ca3a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_autosummary_accessors-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20200616 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

File hashes

Hashes for sphinx_autosummary_accessors-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aea576cd4813aedf14b22a7ab7e7df61c4a10b8a3b5e4484ffa5b7dbc2ac338d
MD5 2ca2a23e15e21ce4904453f861ab93a8
BLAKE2b-256 dcb37ffb7ac43226bb19588d1b5de82ea2576bde2297399e087c0981e9589aa6

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