生成参考文档

生成 docutils 文档

1. 选择DocUtil任务运行/调试配置，并根据需要更改它：指定配置名称、输入和输出目录以及可选键。

2. 启动此运行/调试配置，如运行和重新运行应用程序部分中所述。

为 Sphinx 文档创建初始基础架构

1. 确保 Sphinx 包已与 Python 解释器一起安装（Settings | Project <project name> | Python Interpreter）。有关安装包的更多信息，请参阅安装、卸载和升级包。

2. 转到工具| 狮身人面像快速入门。

3. 如果在“Python 集成工具”页面中未指定Sphinx 工作目录，则会打开“设置工作目录”对话框，建议指定文档的路径。

   

   笔记

   如果您的项目中指定了 Sphinx 工作目录，则不会出现此对话框。

4. 在 PyCharm 打开的控制台中，回答sphinx-quickstart实用程序提供的问题。特别是，指定将存储生成的conf.py文件的源目录。如果在回答这个问题时，您只需按，PyCharm 将使用您在上一步中指定的路径，或者在Python 集成工具页面的Sphinx 工作目录字段中指定的路径。Enter

提示

sphinx -quickstart实用程序仅对特定目录执行一次。如果要在不同的目录中生成 Sphinx 基础结构，请在Python 集成工具页面的Sphinx 工作目录字段中指定它。

生成 Sphinx 文档

1. 通过以下方式之一打开“运行/调试配置”对话框：

   • 选择运行 | 从主菜单编辑配置。

   • 当导航栏可见（视图 | 外观 | 导航栏）时，从运行/调试配置选择器中选择编辑配置。

   • 按，然后按。AltShiftF1000

2. 在“运行/调试配置”对话框中，单击工具栏上的 或按。该列表显示运行/调试配置模板。AltInsert

3. 选择Sphinx任务运行/调试配置，并根据需要进行更改：指定配置名称、输入和输出目录。

4. 启动此运行/调试配置，如运行和重新运行应用程序部分中所述。