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发现来自动注释它无法创建第一个文档存根的所有内容.

Failing that, are there any tools to do this that integrate well with PyCharm?

是:) sphinx-apidoc这是一个可以自动从代码中创建第一个文档的工具.还有一些鲜为人知的autoapi

你只需指向根目录,瞧它甚至可以包含没有doc字符串的成员.它实际上只是使用自动模块语法创建一个简单的第一个文档.之后你可以从PyCharm运行sphinx任务,你有一个代码文档,你甚至可以使用像sphinx_rtd_theme这样的主题使它看起来非常好.

例：

sphinx-apidoc -o source / ../

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

然后在index.rst中添加一行.. toctree :: … 源极/模块