python - NumpyDoc 检查是否符合文档规范?

标签 python numpy python-sphinx docutils numpydoc

<分区>

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

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

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

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

最佳答案

我遇到的最接近的是 doccheck通过@robert-t-mcgibbon:

Check that all docstrings satisfy Numpy format

This is a small script that goes through functions, methods and classes in a package and looks for inconsistencies between the signatures and (Numpy format) docstring.

关于python - NumpyDoc 检查是否符合文档规范?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27993475/

相关文章:

python - cqlsh 无法找到它需要执行的 Python 版本

python - 乘积的有效双和

python - 交叉引用链接到不同子模块中的函数/类

python - JSON 文件到数据帧转换-ValueError : Unexpected character found when decoding array value (2)

python - pandas DataFrame 不合并但不报错

python - 为什么在命令行中使用 sys.argv 时没有引号?

向量函数的 Python fmin(查找最小值)

python - 从两点之间的 numpy 数组获取值

python-sphinx - 在 python-sphinx 生成的页面上显示警告框

带有 Sphinx 生成的文档的 Github 页面无法正确显示 HTML