提取以各种方式定义的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 .
  • 太好了,一切正常!在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
Selenium Webdrive(Java)使用名称的预定义部分生成变量   java如何在Android Studio中创建水平滚动的标题?   Java中的层次枚举   java从响应获取对象列表   从向后兼容的可序列化对象中提取java超类   使用放大按钮在滚动条上显示java ChangeListener   java Jsp默认日期格式   java广播接收器未接收   当字符不是来自英文字母表时,java Datadog字符串编码   java GWT将字符串转换为小数点后2位的浮点值   java Android SMS API   java在codenameone中同时滚动X和Y窗格   Java应用程序使用Datacap WTM服务中止ibm data studio批处理   java如何在Struts配置文件中配置文件夹中的文件路径