{"id":26163829,"url":"https://github.com/xarray-contrib/sphinx-autosummary-accessors","last_synced_at":"2025-04-10T02:28:21.166Z","repository":{"id":37951553,"uuid":"276216520","full_name":"xarray-contrib/sphinx-autosummary-accessors","owner":"xarray-contrib","description":"sphinx extension to document pandas and xarray accessors","archived":false,"fork":false,"pushed_at":"2025-04-01T18:28:30.000Z","size":165,"stargazers_count":14,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-01T19:39:17.056Z","etag":null,"topics":["accessors","pandas","sphinx-doc","xarray"],"latest_commit_sha":null,"homepage":"https://sphinx-autosummary-accessors.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xarray-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-30T21:54:09.000Z","updated_at":"2025-04-01T18:28:34.000Z","dependencies_parsed_at":"2023-02-16T17:20:37.231Z","dependency_job_id":"ee1e13f9-c46a-4d97-8ff6-3f6e4d1568b6","html_url":"https://github.com/xarray-contrib/sphinx-autosummary-accessors","commit_stats":{"total_commits":116,"total_committers":8,"mean_commits":14.5,"dds":0.6551724137931034,"last_synced_commit":"cdf752fb654255fb66d64cdc6f3796b3e8019051"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarray-contrib%2Fsphinx-autosummary-accessors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarray-contrib%2Fsphinx-autosummary-accessors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarray-contrib%2Fsphinx-autosummary-accessors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarray-contrib%2Fsphinx-autosummary-accessors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xarray-contrib","download_url":"https://codeload.github.com/xarray-contrib/sphinx-autosummary-accessors/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248143928,"owners_count":21054845,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessors","pandas","sphinx-doc","xarray"],"created_at":"2025-03-11T14:53:15.467Z","updated_at":"2025-04-10T02:28:21.139Z","avatar_url":"https://github.com/xarray-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx-autosummary-accessors\n============================\n\n.. image:: https://github.com/xarray-contrib/sphinx-autosummary-accessors/workflows/CI/badge.svg?branch=master\n    :target: https://github.com/xarray-contrib/sphinx-autosummary-accessors/actions\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/python/black\n.. image:: https://readthedocs.org/projects/sphinx-autosummary-accessors/badge/?version=latest\n   :target: https://sphinx-autosummary-accessors.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n\nA ``sphinx`` extension to properly document `pandas`_ or `xarray`_ accessors.\n\n``sphinx.ext.autosummary`` is able to create summary and object pages for objects and\ntheir methods, but it doesn't work well with accessor styled properties and methods\n(``obj.accessor.attribute``). ``pandas`` has accessor documentation built using\n``sphinx.ext.autosummary`` templates, which ``xarray`` recently adopted by copying the\ntemplates and all related code.\n\nTo avoid even more duplicated code, and to make it easier for projects to document their\ncustom accessors, this project aims to provide this functionality by way of a `sphinx`_\nextension.\n\nMost of the code was adapted from ``pandas``.\n\nUsage\n=====\nUsing it should be as simple as adding\n\n.. code:: python\n\n   import sphinx_autosummary_accessors\n\n   extensions = [\n       ...,\n       \"sphinx_autosummary_accessors\",\n   ]\n   templates = [\"_templates\", ..., sphinx_autosummary_accessors.templates_path]\n\nto your ``conf.py`` and using the appropriate template:\n\n.. code:: rst\n\n   .. autosummary::\n      :template: autosummary/accessor_method.rst\n\n      Example.test.multiply\n\nDocumentation\n=============\nFor more information and examples, see the `documentation`_.\n\n.. _pandas: https://github.com/pandas-dev/pandas\n.. _xarray: https://github.com/pydata/xarray\n.. _sphinx: https://github.com/sphinx-doc/sphinx\n.. _documentation: https://sphinx-autosummary-accessors.readthedocs.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarray-contrib%2Fsphinx-autosummary-accessors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxarray-contrib%2Fsphinx-autosummary-accessors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarray-contrib%2Fsphinx-autosummary-accessors/lists"}