Use this dialog box 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.
In this section:
|Command||Select the command that will be used to convert the specified *.rst file. The selected command stipulates the output format of the documentation.|
|Input||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+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift Enter to open the file chooser dialog.|
|Output||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+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift Enter to open the file chooser dialog.|
|Option||In this text field, type the keys the script will be launched with.|
|Open output file in browser||If this check box is selected, PyCharm will automatically open the generated documentation in the default browser. Note that the check box is disabled, when it is irrelevant to the command selected in the Command drop-down list.|
|Environment variable||Click the browse button, or press Shift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift 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.|
|Python Interpreter||Select one of the pre-configured Python interpreters from the drop-down list.
Note that you can select a remote interpreter, as well as the local one. If a remote interpreter is selected, you have to specify path mappings in the corresponding field that appears.
|Interpreter options||In this field, specify the string to be passed to the interpreter. If necessary, click , and type the string in the editor.|
|Working directory||Specify a directory to be used by the running task.
|Path mappings||This field appears, if a remote interpreter has been selected in the field Python interpreter.
Click the browse button to define the required mappings between the local and remote paths. In the Edit Path Mappings dialog box, use / buttons to create new mappings, or delete the selected ones.
|2.7.2+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;|
|Is Active||Select check boxes 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:
|Skip Content||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 standard out changes||Select this check box to activate output console and bring it forward, if associated process writes to Standard.out.|
|Show console when standard error changes||Select this check box to activate output console and bring it forward, if 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.|
|Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter||Click this button to add a new configuration to the list.|
|Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete||Click this button to remove the selected configuration from the list.|
|Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCommand DCommand DCommand D||Click this button to create a copy of the selected configuration.|
|Edit defaults||Click this button to edit the default configuration templates. The defaults are used for newly created configurations.|
|or||Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up or Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl Alt Down||Use these buttons to move the selected configuration or folder up and down in the list.
The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.
|Move into new folder / Create new folder||Use this button to create a new folder.
If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created.
Move run/debug configurations to a folder using drag-and-drop, or the buttons.
|Sort configurations||Click this button to sort configurations in alphabetical order.|
|Name||In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.|
|Defaults||This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.|
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 .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.
This check box is not available when editing the run/debug configuration defaults.
|Single instance only||If this check box is selected, this run/debug configuration cannot be launched more than once.
Every time a new run/debug configuration is launched, PyCharm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.
This make sense, when usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.
If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.
|Before launch||Specify which tasks must be performed before applying the run/debug configuration.
The specified tasks are performed in the order they appear in the list.