IntelliJ IDEA
 
2023.2
快捷方式：Windows
获取 IntelliJ IDEA
  1. 非 JVM 技术
  2. Python
  3. Python 运行/调试配置
  4. Python 文档
  5. DocUtil 任务

运行/调试配置：DocUtil 任务

最后修改时间：2023 年 9 月 8 日

警告

以下仅在安装并启用Python插件时有效。

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

配置选项卡

物品

描述

命令

选择将用于转换指定的.rst文件的命令。所选命令规定了文档的输出格式。

输入

指定源.rst文件的完全限定路径。手动键入路径，或单击浏览按钮，然后从文件选择器对话框中选择所需的.rst文件。或者，您可以按打开文件选择器对话框。ShiftEnter

输出

指定生成文件的完全限定路径。手动键入路径，或单击浏览按钮，然后从文件选择器对话框中选择所需的文件。或者，您可以按打开文件选择器对话框。ShiftEnter

选项

在此文本字段中，键入启动脚本所使用的键。

在浏览器中打开输出文件

如果选中此复选框，IntelliJ IDEA 将自动在默认浏览器中打开生成的文档。请注意，当该复选框与“命令”下拉列表中选择的命令无关时，该复选框将被禁用。

环境变量

单击浏览按钮，或按在“环境变量”对话框中指定所需的环境变量集。要创建新变量，请单击，然后键入所需的名称和值。ShiftEnter添加

Python解释器

口译员选项

在此字段中，指定要传递给解释器的命令行选项。如有必要，单击扩大领域，然后在编辑器中键入字符串。

工作目录

指定运行任务要使用的目录。

  • 当通过键盘快捷键或从脚本的上下文菜单中选择“运行”创建默认运行/调试配置时，工作目录就是包含可执行脚本的目录。该目录可能与项目目录不同。CtrlShiftF10

  • 当此字段留空时，将使用 IntelliJ IDEA 安装的bin目录。

您可以在此字段中使用路径变量。

路径映射

如果在Python 解释器字段中选择了远程解释器，则会出现此字段。

单击浏览按钮浏览按钮定义本地路径和远程路径之间所需的映射。在“编辑路径映射”对话框中，使用添加按钮/删除按钮按钮创建新映射，或删除选定的映射。

将内容根添加到 PYTHONPATH

选中此复选框可将项目的所有内容根添加到环境变量 PYTHONPATH 中；

将源根添加到 PYTHONPATH

选中此复选框可将项目的所有源根目录添加到环境变量 PYTHONPATH 中；

Docker 容器设置

警告

仅当为项目选择基于 Docker 的远程解释器时，才会出现此字段。

笔记

谈到设置与某些选项（--net、--link等）的对应关系，请注意这些选项来自Docker 命令行参数。

单击浏览按钮以打开对话框并指定以下设置：

选项

  • 禁用网络：选中此复选框可禁用网络。这对应于--net="none"，这意味着容器内部外部网络资源不可用。

  • 网络模式：对应该选项的其他值--net。

    • bridge是默认值。将为网桥网络上的容器分配一个 IP 地址，并且流量将通过该网桥路由到容器。

      默认情况下，容器可以通过其 IP 地址进行通信。要通过名称进行通信，必须将它们链接起来。

    • host：在容器内使用主机的网络堆栈。

    • container:<name|id>：使用另一个容器的网络堆栈，通过其name或id指定。

    有关更多信息，请参阅网络设置文档。

  • 链接：使用此部分将要创建的容器与其他容器链接。这适用于Network mode = bridge并对应于该--link选项。

  • 发布所有端口：向主机公开所有容器端口。这对应于选项--publish-all。

  • 端口绑定：指定端口绑定列表。-p与使用选项类似docker run。

  • 额外主机：这对应于选项--add-host。有关更多信息，请参阅管理 /etc/hosts。

  • 卷绑定：使用此字段指定特殊文件夹卷与运行 Docker 守护程序的计算机的文件夹之间的绑定。这对应于-v选项。有关更多信息，请参阅管理容器中的数据。

  • 环境变量：使用此字段指定环境变量及其值的列表。这对应于-e选项。有关详细信息，请参阅ENV（环境变量）。

单击应用程序操作向下移动以展开表格。单击应用程序常规添加、应用程序常规删除、 或应用程序操作编辑来组成列表。

日志选项卡

使用此选项卡可以指定在运行或调试时生成的哪些日志文件应显示在控制台中，即显示在“运行”或“调试”工具窗口的专用选项卡上。

物品

描述

活跃

选中此列中的复选框可使日志条目显示在“运行”工具窗口或“调试”工具窗口的相应选项卡中。

日志文件条目

此列中的只读字段列出了要显示的日志文件。该列表可以包含：

  • 特定文件的完整路径。

  • Ant 模式定义要显示的文件范围。

  • 用于替代完整路径或模式的别名。这些别名也会显示在显示相应日志文件的选项卡的标题中。

    如果日志条目模式定义了多个文件，则选项卡标题将显示文件的名称，而不是日志条目别名。

跳过内容

选中此复选框可跳过所选日志的先前内容。

将控制台输出保存到文件

选中此复选框可将控制台输出保存到指定位置。手动键入路径，或单击浏览按钮并指向打开的对话框中的所需位置。

当消息打印到标准输出流时显示控制台

选中此复选框可激活输出控制台，并在关联进程写入 Standard.out 时将其向前显示。

当消息打印到标准错误流时显示控制台

选中此复选框可激活输出控制台，并在关联进程写入 Standard.err 时将其向前显示。

添加按钮

单击此按钮可打开“编辑日志文件别名”对话框，您可以在其中选择新的日志条目并为其指定别名。

编辑按钮

单击此按钮可在“编辑日志文件别名”对话框中编辑所选日志文件条目的属性。

删除按钮

单击此按钮可从列表中删除选定的日志条目。

常用设置

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

物品

描述

姓名

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

允许多个实例

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

默认情况下，它是禁用的，当您在另一个实例仍在运行时启动此配置时，IntelliJ IDEA 建议停止正在运行的实例并启动另一个实例。当运行配置消耗大量资源并且没有充分理由运行多个实例时，这非常有用。

存储为项目文件

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

默认情况下，它是禁用的，IntelliJ IDEA 将运行配置设置存储在.idea/workspace.xml中。

工具栏

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

物品

捷径

描述

添加按钮

AltInsert

创建运行/调试配置。

删除按钮

AltDelete

删除选定的运行/调试配置。请注意，您无法删除默认配置。

复制

Ctrl0D

创建所选运行/调试配置的副本。请注意，您创建默认配置的副本。

保存配置

仅当您选择临时配置时才会显示该按钮。单击此按钮可将临时配置保存为永久配置。

移入新文件夹/创建新文件夹

移入新文件夹/创建新文件夹。您可以通过将运行/调试配置放入文件夹中来对它们进行分组。

要创建文件夹，请选择类别中的配置，单击文件夹，然后指定文件夹名称。如果仅关注某个类别，则会创建一个空文件夹。

然后，要将配置移入文件夹、文件夹之间或移出文件夹，请使用拖动 或提升和下移按钮。

要删除分组，请选择一个文件夹并单击删除配置。

对配置进行排序

单击此按钮可按字母顺序对配置进行排序。

发布前

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

物品

捷径

描述

添加按钮

AltInsert

单击此图标可添加以下可用任务之一：

  • 运行外部工具：选择运行外部应用程序。在打开的对话框中，选择一个或多个要运行的应用程序。如果 IntelliJ IDEA 中尚未定义，请添加其定义。有关详细信息，请参阅外部工具和外部工具设置。

  • 运行另一个配置：选择执行另一个运行/调试配置并等待其完成后再开始当前配置。如果要并行运行多个配置，请使用复合运行/调试配置。

  • Build：选择编译指定的模块。将执行构建模块命令。

    如果编译期间发生错误，IntelliJ IDEA 将不会尝试启动运行/调试配置。

  • Build Project：选择编译整个项目。将执行“构建项目”命令。

    如果编译期间发生错误，IntelliJ IDEA 将不会尝试启动运行/调试配置。

  • Build, no error check ：与Build选项相同，但 IntelliJ IDEA 将尝试启动运行/调试配置，而不管编译结果如何。

  • 构建工件：选择此选项来构建一个或多个工件。在打开的对话框中，选择应构建的一个或多个工件。

  • 启动 Web 浏览器：选择此选项可启动浏览器。在打开的对话框中，选择浏览器类型并提供起始 URL。另外，指定是否希望使用 JavaScript 调试器启动浏览器。

  • 运行 Ant 目标：选择此选项可运行Ant 目标。在打开的对话框中，选择要运行的目标。

  • 运行 Grunt 任务：选择此选项可运行 Grunt 任务。

    在打开的Grunt 任务对话框中，指定定义所需任务的Gruntfile.js ，选择要执行的任务，并指定要传递给 Grunt 工具的参数。

    指定 Node.js 解释器的位置、要传递给它的参数以及grunt-cli包的路径。

  • 运行 gulp 任务：选择此选项可运行 Gulp 任务。

    在打开的Gulp 任务对话框中，指定定义所需任务的Gulpfile.js ，选择要执行的任务，并指定要传递给 Gulp 工具的参数。

    指定 Node.js 解释器的位置、要传递给它的参数以及gulp包的路径。

  • 运行 Maven 目标：选择此选项可运行 Maven 目标。在打开的对话框中，选择要运行的目标。

  • 运行 npm 脚本：选择此选项来执行 npm 脚本。

    在打开的NPM 脚本对话框中，指定npm run/debug 配置设置。

  • 编译 TypeScript：选择运行内置 TypeScript 编译器，从而确保您对 TypeScript 代码所做的所有更改都反映在生成的 JavaScript 文件中。在打开的TypeScript 编译设置对话框中，选中或清除检查错误复选框以配置编译器在检测到任何错误时的行为：

    • 如果选中“检查错误”复选框，编译器将显示所有错误，并且运行配置将不会启动。

    • 如果清除“检查错误”复选框，编译器将显示所有检测到的错误，但仍会启动运行配置。

  • 上传文件到远程主机：选择此选项可以根据默认的服务器访问配置自动将应用程序文件上传到服务器。

  • 运行远程外部工具：添加远程 SSH 外部工具。

  • 断开数据源：如果您想在运行/调试配置运行之前中断与数据源的连接，请选择此选项。

删除按钮

AltDelete

单击此图标可从列表中删除选定的任务。

编辑

Enter

单击此图标可编辑选定的任务。在打开的对话框中进行必要的更改。

方法向上

方法向下

Alt0↑

Alt0↓

单击这些图标可将所选任务在列表中上移或下移一行。任务按照它们在列表中出现的顺序执行。

显示此页

选择此复选框可在实际启动运行/调试配置之前显示运行/调试配置设置。

激活工具窗口

默认情况下，此复选框处于选中状态，并且当您启动运行/调试配置时，将打开“运行”或“调试”工具窗口。

否则，如果清除该复选框，工具窗口将被隐藏。但在配置运行时，您可以通过按或自行打开相应的工具窗口。Alt04Alt05

也可以看看

程序

概念

外部链接