PyCharm 2016.2 Help

Python Integrated Tools

File | Settings | Tools | Python Integrated Tools for Windows and Linux
PyCharm | Preferences | Tools | Python Integrated Tools for OS X
Ctrl+Alt+S
settings

Use this page to configure requirements management file, default test runner, and documentation strings treatment.

ItemDescription
Package requirements fileType 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.
Default test runnerSelect the test run/debug configuration that PyCharm will suggest every time you choose Run on the context menu of a test case. Refer to the section Testing Frameworks for details.
Docstring formatSelect 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 Quick Documentation lookup:

  • Plain: on pressing Enter or Space after opening quotes, an empty stub is generated; quick documentation shows as plain text.
  • reStructuredText: on pressing Enter or Space after opening quotes, stub doc comment is generated according to reStructuredText format; the quick documentation is rendered by Docutils.
  • Epytext: on pressing Enter or Space after opening quotes, stub doc comment is generated according to the epytext format; quick documentation is rendered by epydoc.
  • NumPy: on pressing Enter or Space after opening quotes, stub doc comment is generated according to the NumPy format; the quick documentation is rendered by Napoleon and Docutils.
  • Google: on pressing Enter or Space after opening quotes, stub doc comment is generated according to Google format; the quick documentation is rendered by Napoleon and Docutils.

All types of docstrings feature:

  • Proper generation of docstrings
  • Updates after applying intention actions and quick-fixes
  • Coding assistance
  • Autocompletion for section headers

Note that the information provided in the docstrings, is used for code insight.

py_docstrings
Analyze Python code in docstringsIf this check box is selected, PyCharm highlights the code examples and performs syntax checks and code inspections.
If this check box is not selected, the code fragments inside docstrings are not analyzed.
Sphinx working directorySpecify here the path to the directory that contains *.rst files.
Treat *.txt files as reStructuredTextIf this check box is selected, the files with *.txt extension will be highlighted same way, as the files with *.rst extension.

See Also

Last modified: 29 August 2016