运行/调试配置：DocUtil 任务

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

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

“配置”选项卡

项目	说明
命令	选择用于转换指定 .rst 文件的命令。所选命令决定文档的输出格式。
输入	指定源 .rst 文件的完全限定路径。手动输入路径，或点击“浏览”按钮，并在文件选择对话框中选择所需的 .rst 文件。或者，您可以按 `Shift+Enter` 打开文件选择对话框。
输出	指定生成文件的完全限定路径。手动输入路径，或点击“浏览”按钮，并在文件选择对话框中选择所需的文件。或者，您可以按 `Shift+Enter` 打开文件选择对话框。
选项	在此文本字段中，输入启动脚本时使用的参数。
在浏览器中打开输出文件	选中此复选框后，PyCharm 将在默认浏览器中自动打开生成的文档。请注意，当与命令下拉列表中所选命令无关时，该复选框将被禁用。
环境变量	点击“浏览”按钮，或按 `Shift+Enter` 在“环境变量”对话框中指定所需的环境变量集。要创建新变量，请点击，并输入所需的名称和值。
Python 解释器	从列表中选择一个预配置的 Python 解释器。当 PyCharm 停止支持任何过时的 Python 版本时，对应的 Python 解释器将标记为不受支持。
解释器选项	在此字段中，指定要传递给解释器的命令行选项。如有必要，点击，并在编辑器中输入字符串。
工作目录	指定运行任务要使用的目录。当通过键盘快捷键 `Ctrl+Shift+F10` 创建默认运行/调试配置，或在脚本的上下文菜单中选择运行时，工作目录为包含可执行脚本的目录。该目录可能与项目目录不同。当该字段留空时，将使用 PyCharm 安装的 bin 目录。您可以在此字段中使用路径变量。
将内容根添加到 PYTHONPATH	选中此复选框可将项目的所有内容根添加到环境变量 PYTHONPATH；
将源根添加到 PYTHONPATH	选中此复选框可将项目的所有源根添加到环境变量 PYTHONPATH；
Docker 容器设置仅当为项目选择了基于 Docker 的远程解释器时，才会显示此字段。点击打开对话框并指定以下设置：
选项	发布所有端口：将所有容器端口暴露给主机。这对应于选项 `--publish-all`。端口绑定：指定端口绑定列表。类似于将 `-p` 选项与 `docker run` 一起使用。卷绑定：使用此字段指定特殊文件夹（卷）与运行 Docker 守护进程的计算机上的文件夹之间的绑定。这对应于 `-v` 选项。有关详细信息，请参阅在容器中管理数据。环境变量：使用此字段指定环境变量及其值的列表。这对应于 `-e` 选项。有关详细信息，请参阅 ENV（环境变量）。运行选项：使用此字段指定 Docker 命令行选项。点击展开表格。点击、或以构建列表。

日志

使用这些设置指定在运行或调试期间生成的哪些日志文件应在控制台中显示，即在 Run 或调试工具窗口的专用选项卡上。

有关如何启用日志字段的信息，请参阅设置日志选项。

项目	说明
是否启用	在此列中选中复选框，以便在 “运行”工具窗口或调试工具窗口的相应选项卡中显示日志条目。
日志文件条目	此列中的只读字段列出要显示的日志文件。列表可以包含：特定文件的完整路径。用于替代完整路径或模式的别名。这些别名也会显示在显示相应日志文件的选项卡标题中。如果日志条目模式定义了多个文件，选项卡标题将显示文件名，而不是日志条目别名。
跳过内容	选中此复选框可跳过所选日志的先前内容。
将控制台输出保存到文件	选中此复选框可将控制台输出保存到指定位置。手动输入路径，或点击“浏览”按钮，并在打开的对话框中指向所需位置。
当消息打印到标准输出流时显示控制台	选中此复选框可激活输出控制台，并在关联的进程写入 Standard.out 时将其置于前端。
当消息打印到标准错误流时显示控制台	选中此复选框可激活输出控制台，并在关联的进程写入 Standard.err 时将其置于前端。
	点击此按钮以打开编辑日志文件别名对话框，您可以在其中选择新的日志条目并为其指定别名。
	点击此按钮以在编辑日志文件别名对话框中编辑所选日志文件条目的属性。
	点击此按钮可从列表中移除所选日志条目。
	点击此按钮可编辑所选日志文件条目。仅在选中条目时，该按钮才可用。

通用设置

当您编辑运行配置（而不是运行配置模板）时，您可以指定以下选项：

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

项目

说明

名称(N)

为运行配置指定名称，以便在编辑或运行时能够快速将其与其他配置区分。

允许多个实例(U)

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

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

存储为项目文件(S)

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

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

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

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

启动前

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

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

最后修改日期： 2025年 12月 2日