python - 来自 VScode 的 sphinx 和 autodocstring 以及 python 代码

Question

我正在与使用 vscode 的人合作开展一个项目。我们编写 Python 代码。我让他们为他们的函数生成文档字符串，他们使用了 vscode 的 Autodocstring。这是他们提出的文档字符串:

"""
Subclass ObjectCAD renderToFile method to render the scad file
in renders_dir

Arguments:
    file_path {str} -- the destination path for the scad file

Returns:
    None
"""

它应该是 Google 风格的文档字符串。

当我用 Sphinx 生成 html 文档时，我得到了以下信息:

虽然我应该得到类似的东西:

我是否缺少 sphinx 配置中的选项？还是 Autodocstring 损坏了？

Answer 1

您显示的语法不是 Google 风格的语法(有关详细示例，请参阅 here)。它应该是:

"""
Subclass ObjectCAD renderToFile method to render the scad file
in renders_dir

Args:
    file_path (str): the destination path for the scad file

Returns:
    None
"""

autoDocstring必须正确配置 VSCode 的扩展以生成 Google 风格的文档字符串(查找 autoDocstring.docstringFormat)。