生成参考文档
PyCharm 帮助使用以下文档生成器生成格式化的 API 文档：
请注意以下内容：
文档生成器应正确安装在您的计算机上。 有关更多信息，请参阅它们各自的下载和安装页面。
PyCharm 识别 docstring 格式，并使用在 设置 对话框的 集成工具 页面中定义的文档源目录。
使用 DocUtils 生成参考文档
生成 docutils 文档
选择 DocUtil task 运行/调试配置，并根据需要更改：指定配置名称、输入和输出目录以及可选键。
按照 运行和重新运行应用程序 部分中描述的方式启动此运行/调试配置。
使用 Sphinx 生成参考文档
创建 Sphinx 文档的初始基础结构
确保已使用 Python 解释器安装 Sphinx 包（）。 有关安装包的更多信息，请参阅 安装、卸载和升级软件包。
在主菜单中，转到 。
如果在 集成工具 页面中未指定 Sphinx 工作目录 ，则会打开 设置工作目录 对话框，建议您指定文档路径。
在 PyCharm 中打开的控制台中，回答 sphinx-quickstart 工具提供的问题。 特别是，指定生成的 conf.py 文件将存储的源目录。 如果在回答此问题时，您只按下 Enter ，PyCharm 将使用您在上一步中指定的路径，或在 Sphinx 工作目录 字段的 集成工具 页面中指定的路径。
生成 Sphinx 文档
通过以下方法之一打开 运行/调试配置 对话框：
请选择 从主菜单。
在 Navigation bar 可见 () 的情况下，从运行/调试配置选择器中选择 。
请按 Alt+Shift+F10 然后按 0。
在 运行/调试配置 对话框中，点击工具栏上的
或按 Alt+Insert。 该列表显示运行/调试配置模板。
选择 Sphinx task 运行/调试配置，并根据需要更改：指定配置名称、输入和输出目录。
按照 运行和重新运行应用程序 部分中描述的方式启动此运行/调试配置。
在 Sphinx 文档中重用文档字符串
设置 Sphinx 文档的初始基础结构。
在您的 conf.py 文件中，确保启用了以下扩展：
extensions = [ ..., 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', ]这些扩展可让您重用文档字符串并自动生成摘要页面。
在源代码中的 Python 函数、类或异常中添加文档字符串。
在您的 .rst 文件中，添加指令以在文档中重用相应的文档字符串。 例如：
.. autofunction:: module_name.function_name.. autoexception:: module_name.exception要自动记录多个对象，请使用：
.. autosummary:: :toctree: generated module_name这将为模块中所有已记录的对象生成内容目录。