3

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

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

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

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

4

1 回答 1

0

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

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

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

于 2016-01-11T18:31:29.657 回答