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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: sphinx-autosummary-accessors-0.1.tar.gz
  • Upload date:
  • Size: 13.9 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.tar.gz
Algorithm Hash digest
SHA256 f22ab9828e9badb199de56e223c2d3483b463c930110aec6f88efa726f4f6ae2
MD5 f4b18e5d096b38e257c15e60a4fc5899
BLAKE2b-256 c001656a981d45c0ad49adc8ff2e37124c03846434b4d9a73b819beece5db9c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_autosummary_accessors-0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 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-py3-none-any.whl
Algorithm Hash digest
SHA256 2b2761cddaa401382f4c02f90e39e732fb240130bca7674d97c44ca24109d643
MD5 21cfc099a885ee41f034e28eeadfa7ac
BLAKE2b-256 a1a094acd8cc33faf163b5620d31c7b2de45302efd8f73be00f1b590fc137cce

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