PyCharm 3.1.0 Web Help

File | Settings | Python Integrated Tools

settings

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 file system using the Select Path dialog.
Default test runner Select 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 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 Quick Documentation lookup:

  • Plain: on pressing EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter after opening quotes, an empty stub is generated; quick documentation shows as plain text.
  • reStructuredText: on pressing EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter after opening quotes, stub doc comment is generated according to reStructuredText format; the quick documentation is rendered by Sphinx.
  • Epytext: on pressing EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter after opening quotes, stub doc comment is generated according to the epytext format; quick documentation is rendered by epydoc.
2.7.1+Analyze Python code in docstrings If this check box is selected, PyCharm highlights the code example and performs syntax checks and code inspections.
If this check box is not selected, the code fragments inside docstrings are not analyzed.
Sphinx working directory Specify here the path to the directory that contains *.rst files.

Note

For recognizing custom roles, point to the directory with conf.py.

Treat *.txt files as reStructuredText If this check box is selected, the files with *.txt extension will be highlighted same way, as the files with *.rst extension.

See Also

Procedures:

Reference:

External Links:

Web Resources: