NumpyDoc检查是否符合doc规范?

时间:2015-01-16 21:59:59

标签: python numpy documentation python-sphinx docutils

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

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

图像是一个更成熟的库,其中包含大量文档,希望采用Numpy文档规范。一种方法是内省库并生成描述doc字符串状态的报告。

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

1 个答案:

答案 0 :(得分:0)

我遇到的最接近的事是@ {robert-t-mcgibbon doccheck

  

检查所有文档字符串是否满足Numpy格式

     

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

相关问题