Python Integrated Tools
Use this page to configure requirements management file, default test runner, and documentation strings treatment.
Item | Description |
|---|---|
Package requirements file | Type the name of the requirements file, or click the browse button, and select the desired requirements file from the file system using the Select Path dialog. |
Path to Pipenv executable | This path is required for adding a Pipenv environment to the Python project. The path can be autodetected by the system if added to the
|
Default test runner | Select the test run/debug configuration that PyCharm will suggest every time you choose on the context menu of a test case. The possible options are:
|
Detect tests in Jupyter Notebooks | Select this checkbox if you want to include Jupyter Notebook files in the scope of unit test detection. |
Docstring format | Select the format of the documentation strings to be recognized by PyCharm. Depending on the selected docstring format, PyCharm will generate the stub documentation comments and render text in the show quick documentation:
All types of docstrings feature:
|
Analyze Python code in docstrings | If this checkbox is selected, PyCharm highlights the code examples and performs syntax checks and code inspections. If this checkbox is not selected, the code fragments inside docstrings are not analyzed. |
Render external documentation for | Enables showing documentation for standard library functions from http://docs.python.org in . |
Sphinx working directory | Specify here the path to the directory that contains .rst files. |
Treat .txt files as reStructuredText | If this checkbox is selected, the files with .txt extension will be highlighted same way, as the files with .rst extension. |