JetBrains DataSpell 2021.2 Help

Run/Debug Configuration: Sphinx Task

Use this dialog 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.

Configuration tab

ItemDescription
CommandSelect the command that will be used to convert the specified .rst file. The selected command stipulates the output format of the documentation.
InputSpecify 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.
OutputSpecify 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.
OptionIn this text field, type the keys the script will be launched with.
Environment variableClick 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 Icons general add, and type the desired name and value.
Python Interpreter

Select one of the pre-configured Python interpreters from the list.

Note that you can select a, as well as the local one. If a remote interpreter is selected (in the %edition% edition), you have to specify path mappings in the corresponding field that appears.

Interpreter optionsIn this field, specify the command-line options to be passed to the interpreter. If necessary, click Expand the field, and type the string in the editor.
Working directory

Specify a directory to be used by the running task.

  • When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10, or by choosing Run from the context menu of a script, the working directory is the one that contains the executable script. This directory may differ from the project directory.

  • When this field is left blank, the bin directory of the JetBrains DataSpell installation will be used.

Path mappings

This field appears, if a remote interpreter has been selected in the field Python interpreter.

Click the browse button the Browse button to define the required mappings between the local and remote paths. In the Edit Path Mappings dialog, use the Add button/ the Remove button buttons to create new mappings, or delete the selected ones.

Add content roots to PYTHONPATHSelect this checkbox to add all content roots of your project to the environment variable PYTHONPATH;
Add source roots to PYTHONPATHSelect this checkbox to add all source roots of your project to the environment variable PYTHONPATH;
Docker container settings

Click the Browse button to open the dialog and specify the following settings:

Options
  • Disable networking: select this checkbox to have the networking disabled. This corresponds to --net="none", which means that inside a container the external network resources are not available.

  • Network mode: corresponds to the other values of the option --net.
    • bridge is the default value. An IP address will be allocated for container on the bridge’s network and traffic will be routed through this bridge to the container.

      Containers can communicate via their IP addresses by default. To communicate by name, they must be linked.

    • host: use the host's network stack inside the container.

    • container:<name|id>: use the network stack of another container, specified via its name or id.

    Refer to the Network settings documentation for details.

  • Links: Use this section to link the container to be created with the other containers. This is applicable to Network mode = bridge and corresponds to the --link option.

  • Publish all ports: Expose all container ports to the host. This corresponds to the option --publish-all.

  • Port bindings: Specify the list of port bindings. Similar to using the -p option with docker run.

  • Extra hosts: This corresponds to the --add-host option. Refer to the page Managing /etc/hosts for details.

  • Volume bindings: Use this field to specify the bindings between the special folders- volumes and the folders of the computer, where the Docker daemon runs. This corresponds to the -v option. See Managing data in containers for details.

  • Environment variables: Use this field to specify the list of environment variables and their values. This corresponds to the -e option. Refer to the page ENV (environment variables) for details.

Click Icons actions move down to expand the tables. Click Icons general add, Icons general remove, or Icons actions edit to make up the lists.

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

ItemDescription
Is ActiveSelect 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:

  • Full paths to specific files.

  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip ContentSelect this checkbox to have the previous content of the selected log skipped.
Save console output to fileSelect 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 streamSelect 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 streamSelect this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.
the Add buttonClick this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
the Edit buttonClick this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
the Delete buttonClick this button to remove the selected log entry from the list.
the Browse buttonClick this button to edit the select log file entry. The button is available only when an entry is selected.

Common settings

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

Name

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, JetBrains DataSpell 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 JetBrains DataSpell stores run configuration settings in .idea/workspace.xml.

Toolbar

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.

ItemShortcutDescription
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Move into new folder / Create new folder

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 Folder, 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 Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

ItemShortcutDescription
the Add buttonAlt+Insert

Click this icon to add one of the following available tasks:

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in JetBrains DataSpell yet, add its definition.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • Run File Watchers: select this option to have JetBrains DataSpell apply all the currently active File Watchers.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run gulp task: select this option to run a Gulp task.

    In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm script: select this option to execute an npm script.

    In the NPM Script dialog that opens, specify the npm run/debug configuration settings.
  • Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through react-native start. If your application uses Expo, you need to run the development server via the start npm task. To do that, click Add, then in the Configure React Native dialog, choose npm script and select start from the list.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+Up/ Alt+DownClick 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 pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

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.

Last modified: 26 April 2021