NumpyDoc 检查是否符合文档规范？ [关闭]答案

【问题标题】：NumpyDoc Checking for conformity to the doc spec? [closed]NumpyDoc 检查是否符合文档规范？ [关闭]
【发布时间】：2015-01-16 21:59:58
【问题描述】：

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

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

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

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

【问题讨论】：

【解决方案1】：

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

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

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

【讨论】：

这在理论上可以回答这个问题，但最好将答案的基本部分包含在此处以供将来的用户使用，并提供链接以供参考。 Link-dominated answers 可以通过link rot 失效。