Run/Debug Configuration: Sphinx Task
Use this dialog box to create a run/debug configuration for a Sphinx task, which allows you to produce documentation in some reasonable format (for example, HTML), from a file in the reStructuredText format.
In this section:
Select the command that will be used to convert the specified
Specify the fully qualified path to the source
Specify the fully qualified path to the generated directory where the generated files will be placed. Type the path manually, or click the browse button, and choose the desired file from the file chooser dialog. Alternatively, you can press Shift+Enter to open the Select Path dialog.
In this text field, type the keys the script will be launched with.
Click the browse button, or press Shift+Enter to specify the desired set of environment variables in the Environment Variables dialog box. To create a new variable, click , and type the desired name and value.
Select one of the pre-configured Python interpreters from the drop-down list.
In this field, specify the string to be passed to the interpreter. If necessary, click , and type the string in the editor.
|Specify a directory to be used by the running task. |
Add content roots to PYTHONPATH
Select this check box to add all content roots of your project to the environment variable PYTHONPATH;
Add source roots to PYTHONPATH
Select this check box to add all source roots of your project to the environment variable PYTHONPATH;
Docker container settings
Click to open the dialog and specify the following settings:
Click to expand the tables. Click , , or to make up the lists.
Log File Entry
The read-only fields in this column list the log files to show. The list can contain:
Select this check box to have the previous content of the selected log skipped.
Save console output to file
Select this check box to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when a message is printed to standard output stream
Select this check box to activate the output console and bring it forward if an associated process writes to Standard.out.
Show console when a message is printed to standard error stream
Select this check box to activate the output console and bring it forward if an associated process writes to Standard.err.
Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
Click this button to remove the selected log entry from the list.
Click this button to edit the select log file entry. The button is available only when an entry is selected.
When you edit a run configuration (but not a run configuration template), you can specify the following options for it:
In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).
| Select this check box to make the run/debug configuration available to other team members. |
The shared run/debug configurations are kept in separate xml files under
Single instance only
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
Move into new folder / Create new folder
You can group run/debug configurations by placing them into folders.
To create a folder, select the configurations within a category, click , and specify folder name. If only a category is in focus, an empty folder is created.
Then, to move a configuration into a folder, between the folders or out of a folder, use drag-and-drop or and buttons.
To remove grouping, select a folder and click .
Click this button to sort configurations in the alphabetical order.
Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.
When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:
Configurations available in Run Dashboard
In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.
Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Confirm rerun with process termination
|The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration. |
Temporary configurations limit
Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Before Launch options
In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Click these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this page
Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window
Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.