Numpy项目为文档的格式化提供了规范,以支持可读性和自动提取(link)。它们还提供Numpydoc,作为Sphinx的扩展,以支持提取一些额外的关键字。
在开始编写docutils的扩展之前,是否存在一个库来帮助内省现有的文档字符串并识别不符合Numpy标准的内容。
想象一个包含大量文档的更成熟的库,这些库想要采用Numpy文档规范。一种方法是内省该库,并生成一个描述文档字符串状态的报告。
在开始将其作为docutils或numpydoc的扩展实现之前,这是一个侦测问题。我是错过了一个现有的解决方案,还是存在一个优雅的解决方案?
发布于 2016-01-12 02:31:30
我遇到的最接近的东西是@robert-t-mcgibbon写的doccheck:
doccheck
检查所有文档字符串是否满足Numpy格式
这是一个小脚本,它遍历包中的函数、方法和类,并查找签名和(Numpy格式)文档字符串之间的不一致。
https://stackoverflow.com/questions/27993475
相似问题