Run/Debug Configuration: DocUtil Task
Use this dialog to create a run/debug configuration for a DocUtils task, which allows you to produce documentation in some reasonable format (for example, HTML), from a file in the reStructuredText format.
Refer to Generate reference documentation for more information on using DocUtils.
|Select the command that will be used to convert the specified .rst file. The selected command stipulates the output format of the documentation.
|Specify the fully qualified path to the source .rst file. Type the path manually, or click the browse button, and choose the desired .rst file from the file chooser dialog. Alternatively, you can press Shift+Enter to open the file chooser dialog.
|Specify the fully qualified path to the generated file. 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 file chooser dialog.
|In this text field, type the keys the script will be launched with.
|Open output file in browser
|If this checkbox is selected, PyCharm will automatically open the generated documentation in the default browser. Note that the checkbox is disabled, when it is irrelevant to the command selected in the Command drop list.
|Click the browse button, or press Shift+Enter to specify the desired set of environment variables in the Environment Variables dialog. To create a new variable, click , and type the desired name and value.
Select one of the pre-configured Python interpreters from the list.
|In this field, specify the command-line options 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 checkbox to add all content roots of your project to the environment variable PYTHONPATH;
|Add source roots to PYTHONPATH
|Select this checkbox 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.
|Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
|Log File Entry
The read-only fields in this column list the log files to show. The list can contain:
|Select this checkbox to have the previous content of the selected log skipped.
|Save console output to file
|Select this checkbox 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 checkbox 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 checkbox 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:
Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.
Allow parallel run
Select to allow running multiple instances of this run configuration in parallel.
By default, it is disabled, and when you start this configuration while another instance is still running, PyCharm suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.
Store as project file
Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.
By default, it is disabled, and PyCharm stores run configuration settings in .idea/workspace.xml.
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.
|The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
|View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and 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 the 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 or and buttons.
To remove grouping, select a folder and click .
|Click this button to sort configurations in the alphabetical order.
In this area you can specify tasks that must 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, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.