DocUtil 任务 Z任务Z

创建：运行(U)｜编辑配置(E)｜ | Python 文档 | Docutils 任务

使用此对话框为 DocUtils 任务创建运行/调试配置，该任务允许您从 reStructuredText 格式的文件生成某种合理格式（例如， HTML）的文档。

有关使用 DocUtils 的更多信息，请参阅生成参考文档。

运行/调试配置的树形视图包含一个工具栏，可帮助您管理您的项目中可用的配置，并调整默认配置模板。

项目	快捷方式	描述
	`Alt+Insert`	创建运行/调试配置。
	`Alt+Delete`	删除选定的运行/调试配置。请注意，您无法删除默认配置。
	`Ctrl+D`	创建所选运行/调试配置的副本。请注意，您将创建默认配置的副本。
		仅当您选择了临时配置时，才会显示该按钮。点击此按钮以将临时配置保存为永久配置。
		移入新文件夹／创建新文件夹。您可以通过将其放入文件夹对运行/调试配置进行分组。要创建文件夹，请在某个分类中选择配置，点击，并指定文件夹名称。如果仅选中了某个类别，则会创建一个空文件夹。随后，要将某个配置移入文件夹、在文件夹之间移动或移出文件夹，请使用拖动操作，或使用和按钮。要取消分组，请选择一个文件夹并点击。
		点击此按钮按字母顺序排序配置。

常用选项

项目	描述
名称(N)	为运行配置指定名称，便于在编辑或运行时快速识别。
允许多个实例(U)	允许并行运行此运行配置的多个实例。默认情况下，该选项处于禁用状态。当您在另一个实例仍在运行时启动此配置，PyCharm 会建议先停止正在运行的实例，再启动另一个实例。当某个运行配置占用大量资源且没有充分理由运行多个实例时，这将很有帮助。
存储为项目文件(S)	将包含运行配置设置的文件保存下来，以便与团队其他成员共享。默认位置是 .idea/runConfigurations 。但是，如果您不想共享 .idea 目录，可以将该配置保存到项目内的任何其他目录。默认情况下，该选项处于禁用状态，并且 PyCharm 会将运行配置设置存储在 .idea/workspace.xml 中。

项目

描述

名称(N)

为运行配置指定名称，便于在编辑或运行时快速识别。

允许多个实例(U)

允许并行运行此运行配置的多个实例。

默认情况下，该选项处于禁用状态。当您在另一个实例仍在运行时启动此配置，PyCharm 会建议先停止正在运行的实例，再启动另一个实例。当某个运行配置占用大量资源且没有充分理由运行多个实例时，这将很有帮助。

存储为项目文件(S)

将包含运行配置设置的文件保存下来，以便与团队其他成员共享。默认位置是 .idea/runConfigurations 。但是，如果您不想共享 .idea 目录，可以将该配置保存到项目内的任何其他目录。

默认情况下，该选项处于禁用状态，并且 PyCharm 会将运行配置设置存储在 .idea/workspace.xml 中。

Docutils 专用配置选项

项目	描述
Docutil 任务
Command	选择用于转换指定 .rst 文件的命令。所选命令决定文档的输出格式。
输入	指定源 .rst 文件的完整路径。手动输入路径，或点击浏览按钮，并在文件选择对话框中选择所需的 .rst 文件。或者，您可以按 `Shift+Enter` 打开文件选择对话框。
输出	指定生成文件的完全限定路径。手动输入路径，或点击浏览按钮，并在文件选择对话框中选择所需文件。或者，您可以按 `Shift+Enter` 打开文件选择对话框。
选项	在此文本字段中，输入启动脚本时使用的参数。
在浏览器中打开输出文件	选中此复选框后，PyCharm 将在默认浏览器中自动打开生成的文档。请注意，当与 Command 下拉列表中所选命令无关时，该复选框将被禁用。
环境
环境变量	点击浏览按钮，或按 `Shift+Enter` 在 Environment Variables 对话框中指定所需的环境变量集。要创建新变量，请点击，然后键入所需的名称和值。
Docker 容器设置此字段仅在为项目选择了基于 Docker 的远程解释器时显示。点击打开对话框，并指定以下设置：
选项	发布所有端口：将所有容器端口公开给主机。对应于 `--publish-all` 选项。端口绑定：指定端口绑定列表。类似于与 `docker run` 一起使用 `-p` 选项。卷绑定：在此字段中指定特殊文件夹（卷）与运行 Docker 守护进程的计算机上的文件夹之间的绑定。这对应于 `-v` 选项。有关详细信息，请参阅管理容器中的数据。环境变量：在此字段中指定环境变量及其值的列表。这对应于选项 `-e`。有关详细信息，请参阅 ENV（环境变量）。运行选项：在此字段中指定 Docker 命令行选项。点击展开表格。点击、或来构建列表。

启动前

在此区域中，您可以指定在启动所选运行/调试配置之前要执行的任务。任务按照其在列表中的顺序执行。

项目	快捷方式	描述
	`Alt+Insert`	点击该图标以添加以下可用任务之一：启动Web 浏览器：选择此选项可启动浏览器。在打开的对话框中，选择浏览器类型，并提供启动 URL。此外，指定是否使用 JavaScript 调试器启动浏览器。运行外部工具：选择此项以运行外部应用程序。在打开的对话框中，选择您要运行的一个或多个应用。如果它尚未在 PyCharm 中定义，请添加相应定义。详细信息请参阅外部工具和外部工具。运行另一个配置：选择执行另一个运行/调试配置，并在启动当前配置之前等待其结束。如果您想并行运行多个配置，请使用复合运行/调试配置。运行File Watcher ：选择此选项以让 PyCharm 应用所有当前活动的文件监视器。运行远程外部工具：添加一个远程 SSH 外部工具。运行Grunt 任务: 选择此选项以运行 Grunt 任务。在 Grunt 任务对话框中，指定 Gruntfile.js ，其中定义了所需的任务，选择要执行的任务，并指定要传递给 Grunt 工具的参数。指定 Node.js 运行时的位置、要传递给它的参数以及指向 grunt-cli 包的路径。运行gulp 任务: 选择此选项以运行 Gulp 任务。在 Gulp 任务对话框中，指定 Gulpfile.js ，其中定义了所需的任务，选择要执行的任务，并指定要传递给 Gulp 工具的参数。指定 Node.js 运行时的位置、要传递给它的参数以及指向 gulp 包的路径。运行npm 脚本: 选择此选项以执行 npm 脚本。在打开的 NPM 脚本对话框中，指定 npm run/debug configuration settings。编译TypeScript ：选择运行内置的 TypeScript 编译器，从而确保您对 TypeScript 代码所做的所有更改反映在生成的 JavaScript 文件中。在打开的 TypeScript 编译设置对话框中，选择或清除检查错误复选框，以在检测到任何错误时配置编译器的行为：如果选中检查错误复选框，编译器将显示所有错误，并且运行配置将不会启动。如果清除了检查错误复选框，编译器将显示所有检测到的错误，但仍会启动运行配置。断开数据源：如果您希望在运行/调试配置之前断开与数据源的连接，请选择此选项。
	`Alt+Delete`	点击该图标可从列表中移除所选任务。
	`Enter`	点击该图标可编辑所选任务。在打开的对话框中，进行必要的更改。
	`Alt+Up` `Alt+Down`	点击这些图标以将所选任务在列表中上移一行或下移一行。任务按照其在列表中的顺序执行。
显示此页面		选中此复选框，以在实际启动运行/调试配置之前显示其设置。
激活工具窗口		默认情况下，该复选框处于选中状态，并且当您启动运行/调试配置时，会打开运行或调试工具窗口。否则，如果清除此复选框，将隐藏工具窗口。但是，当配置正在运行时，您可以按 `Alt+4` 或 `Alt+5` 自行为其打开相应的工具窗口。
聚焦工具窗口		选中此复选框可在启动运行/调试配置时，自动将焦点移动到运行或调试工具窗口。

日志

以下选项与记录此配置的执行相关。有关更多信息，请参见设置日志选项。

项目	描述
指定要在控制台中显示的日志	指定在运行应用程序时显示哪些日志文件。点击添加新日志。在编辑日志文件别名对话框中，配置以下内容：别名(A) ：日志将显示的选项卡名称。日志文件位置(L) ：指定日志文件的路径或 Ant 模式。如果多个滚动日志文件匹配该模式，PyCharm 将显示最新的一个。显示可由模式覆盖的所有文件(S) ：显示所有匹配该模式的日志。对于表格中的日志，您可以配置以下选项：处于活动状态：显示指定的日志文件。跳过内容：不显示先前运行的旧日志消息。
将控制台输出保存到文件(S)	将控制台输出保存到指定位置。手动输入路径，或点击浏览按钮，然后在打开的对话框中指向所需位置。
在消息打印到stdout 时显示控制台	当应用程序写入标准输出流时激活控制台。
在消息打印到stderr 时显示控制台	当应用程序写入标准错误流时激活控制台。

2026年 3月 24日