我很快就开始了一个开源Python项目，我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用reStructuredText和Sphinx与autodoc，因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx自动为我构建API文档。

问题是它使用的reStructuredText语法 - 我认为它在呈现之前是完全不可读的。例如：

：param path：要包装的文件的路径
：type path：str
：param field_storage：要包装的：class：`FileStorage`实例
：type field_storage：FileStorage
：param temporary：是否在File实例时删除文件
    被毁坏了
：type temporary：bool

你必须真的放慢速度，花一点时间才能理解这种语法混乱。我更喜欢谷歌方式（谷歌Python风格指南），与上面的对应方式如下：

ARGS：
    path（str）：要包装的文件的路径
    field_storage（FileStorage）：要包装的FileStorage实例
    temporary（bool）：是否在File下删除文件
        实例被破坏了

方式更好！但是，当然，Sphinx将没有这一点，并在“Args：”之后的所有文本中提取一行。

总而言之 - 在我使用这个reStructuredText语法去玷污我的代码库之前，我想知道是否有任何真正的替代方法来使用它和Sphinx，而不仅仅是编写我自己的API文档。例如，是否有Sphinx的扩展程序可以处理Google Style Guide的文档字符串样式？

解决方案

我创建了一个Sphinx扩展，它解析了Google风格和NumPy风格的文档字符串，并将它们转换为标准的reStructuredText。

要使用它，只需安装它：

$ pip install sphinxcontrib-napoleon 

并在conf.py中启用它：

# conf.py

# Add autodoc and napoleon to the extensions list
extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']

这里有更多关于拿破仑的文件。