Python Integrated Tools
for Windows and Linux
Use this page to configure requirements management file, default test runner, and documentation strings treatment.
|Package requirements file||Type the name of the requirements file, or click the browse button, and select the desired requirements file from 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:
|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:
Note that the information provided in the docstrings, is used for code insight.
|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.|