将Python文档字符串从reStructured Text转换为Google样式的简单方法?

时间:2017-07-06 17:22:03

标签: python python-sphinx docstring google-style-guide sphinx-napoleon

现在有人以简单的方式将现有项目中的所有文档字符串从reStructured Text转换为Google format吗?

看起来Napoleon可以做类似的事情,但看起来很复杂,所以我想我以前是否有人这样做过。任何想法都会非常感激。

1 个答案:

答案 0 :(得分:8)

尝试使用pyment将文档字符串从reStructuredText转换为Google格式。然后使用Napolean通过Sphinx生成文档。

  

Napoleon是一个预处理器,它解析NumPy和Google风格的文档字符串,并在Sphinx尝试解析之前将它们转换为reStructuredText。