python生成api文档_如何在PyCharm中自动生成Python API文档

简而言之，我也偶然发现了这个问题：My question is this: Can I use the DocUtils or Sphinx features of PyCharm to generate the API documentation?

不可以。但是，您可以使用PyCharm快速查看文档ctrl+Q，它将很好地格式化为链接、表等Failing that, can I use any features of PyCharm to do this?

实际上，PyCharm只能插入函数和方法的文档存根，但它不能执行api发现来自动注释它也不能创建rst文档存根的所有内容。Failing that, are there any tools to do this that integrate well with PyCharm?

是的：）sphinx-apidoc这是一个工具，可以从代码中自动创建rst文档。还有一些鲜为人知的autoapi

你只要指向根目录，它甚至可以包含没有doc字符串的成员。它实际上只是使用automodule语法创建一个简单的rst文档。之后，您就可以从PyCharm运行sphinx任务，并且有一个代码文档，您甚至可以使用类似于sphinx_rtd_theme的主题来使它看起来非常漂亮。

示例：

sphinx-apidoc -o source/ ../

假设您在项目中创建了一个doc文件夹，然后cd doc并使用sphinx-quickstart，上面的命令将转到父目录以发现任何源文件并记录它们。结果存储在/doc/source文件夹中。在其他文件中，modules.rst会将所有自动生成的文件拉到一起。

然后在index.rst中，在.. toctree::

...

source/modules中添加一行