sphinx-autosummary-accessors 2023.4.0

sphinx-autosummary-accessors

这是一个 sphinx 扩展，用于正确记录 pandas 或 xarray 访问器。

sphinx.ext.autosummary 可以为对象及其方法创建摘要和对象页面，但它与访问器样式属性和方法（obj.accessor.attribute）配合不佳。pandas 使用 sphinx.ext.autosummary 模板构建访问器文档，而 xarray 最近通过复制模板和相关代码采用了这种方法。

为了避免更多的代码重复，并使项目记录自定义访问器更容易，该项目旨在通过 sphinx 扩展提供此功能。

大部分代码是从 pandas 调整过来的。

用法

使用它应该像添加

import sphinx_autosummary_accessors

extensions = [
    ...,
    "sphinx_autosummary_accessors",
]
templates = ["_templates", ..., sphinx_autosummary_accessors.templates_path]

到您的 conf.py 并使用适当的模板一样简单

.. autosummary::
   :template: autosummary/accessor_method.rst

   Example.test.multiply

文档

有关更多信息和方法，请参阅 文档。