文件名称:sphinx-autosummary-accessors:sphinx扩展,用于记录熊猫和xarray访问器
文件大小:24KB
文件格式:ZIP
更新时间:2024-03-26 01:18:51
pandas xarray sphinx-doc accessors Python
狮身人面像自动摘要访问器 一个sphinx扩展名,可正确记录或访问器。 autosummary能够为对象及其方法创建摘要页面和对象页面,但不适用于访问器样式的属性和方法( obj.accessor.attribute )。 pandas使用自动autosummary模板构建了访问者文档, xarray最近通过复制模板和所有相关代码而采用了该模板。 为了避免更多重复的代码,并使项目更易于记录其自定义访问器,该项目旨在通过sphinx扩展提供此功能。 一旦完成,使用它(几乎)就像在项目的conf.py为extensions添加"accessors"一样简单。 大部分代码是从pandas改编而来的。
【文件预览】:
sphinx-autosummary-accessors-master
----readthedocs.yml(143B)
----README.rst(1KB)
----.github()
--------workflows()
----sphinx_autosummary_accessors()
--------__init__.py(1KB)
--------autosummary.py(6KB)
--------templates()
--------documenters.py(3KB)
----requirements.txt(79B)
----LICENSE(1KB)
----setup.cfg(1KB)
----setup.py(91B)
----.pre-commit-config.yaml(506B)
----licenses()
--------PANDAS_LICENSE(2KB)
----docs()
--------templates.rst(1KB)
--------conf.py(3KB)
--------usage.rst(817B)
--------requirements.txt(82B)
--------whats-new.rst(633B)
--------environment.yml(377B)
--------index.rst(1KB)
--------examples.rst(1KB)
--------installing.rst(444B)
--------example.py(1KB)
----.gitignore(2KB)
----pyproject.toml(146B)