NumpyDoc检查是否符合doc规范?

2024-07-01 08:20:52 发布

您现在位置:Python中文网/ 问答频道 /正文

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

在开始编写docutils的扩展之前,是否存在一个库来帮助反省现有的docstring并识别不符合Numpy标准的情况。你知道吗

想象一个更成熟的库,它有大量的文档,想要采用Numpy文档规范。一种方法是内省库并生成一个描述文档字符串状态的报告。你知道吗

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


Tags: 项目文档numpy规范标准格式sphinxlink
1条回答
网友
1楼 · 发布于 2024-07-01 08:20:52

我遇到的最接近的是@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.

相关问题 更多 >

    热门问题