提取以各种方式定义的docstring属性
class-doc的Python项目详细描述
类文档
一小组助手,旨在从类定义中提取类属性文档。这个东西试图尽可能地模仿sphinx-autodoc behaviour(除了在__init__
函数中定义的实例属性)。在
与sphinx-autodoc相比,此项目的主要优点是它是轻量级的单用途依赖,而autodoc只是真正繁重项目的一小部分。在
安装
此软件包在PyPI上提供
pip install class-doc
示例
不知羞耻地从sphinx-autodoc文档中偷走
^{pr2}$开发设置
项目需要Poetry作为开发设置。在
- 如果你还没有得到它
pip install poetry
- 安装项目依赖项
poetry install
- 运行测试
poetry run pytest .
- 太好了,一切正常!在
- 项目
标签: