NumpyDoc正在检查是否符合文档规范? [关闭]

问题描述 投票:3回答:1

Numpy项目提供了其文档格式的规范,以支持可读性和自动提取(link)。它们还提供Numpydoc作为Sphinx的扩展,以支持提取一些其他关键字。

在开始编写docutils的扩展名之前,是否存在一个库来帮助内省现有文档字符串并识别与Numpy标准不符的库。

为一个更成熟的库提供图像,该库包含要采用Numpy文档规范的大量文档。一种方法是对库进行内部检查并生成描述文档字符串状态的报告。

这是侦察问题,在开始将其实现为docutils或numpydoc的扩展之前。我错过了现有的解决方案还是存在一个优雅的解决方案?

python numpy python-sphinx docutils numpydoc
1个回答
0
投票

我遇到的最接近的东西是@ robert-t-mcgibbon的doccheck

检查所有文档字符串是否均符合Numpy格式

这是一个小脚本,它遍历包中的函数,方法和类,并在签名和(数字格式)文档字符串之间查找不一致之处。

© www.soinside.com 2019 - 2024. All rights reserved.