文档源代码

PyCharm 使用以下文档生成器帮助生成格式化的 API 文档:

请注意以下几点:

使用 DocUtils 生成参考文档

生成 docutils 文档

  1. 选择DocUtil任务运行/调试配置,根据需要进行修改:指定配置名称、输入输出目录、可选键。

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

使用 Sphinx 生成参考文档

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

  1. 确保 Sphinx 包已与 Python 解释器一起安装(Settings/Preferences | Project <project name> | Python Interpreter)。有关如何在 PyCharm 中安装包的更多信息,请参阅安装、卸载和升级包。

  2. 从主菜单中,选择工具 | 狮身人面像快速入门

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

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

生成 Sphinx 文档

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

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

    • 导航栏可见的情况下(查看 | 外观 | 导航栏),从运行/调试配置选择器中选择编辑配置。

    • Alt+Shift+F10,然后按0

  2. 在“运行/调试配置”对话框中,单击图标一般添加工具栏上的 或按Alt+Insert。该列表显示运行/调试配置模板。

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

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

最后修改时间:2021 年 9 月 2 日