PyCharm 2018.3 Help

Generating Reference Documentation

PyCharm helps produce the formatted API documentation, using the following documentation generators:

Mind the following:

  • The documentation generators should be properly installed on your machine. Refer to their respective download and installation pages for details.

  • PyCharm recognizes the docstring format and uses the documentation source directory defined in the Python Integrated Tools page of the Settings dialog.

Generating Reference Documentation Using DocUtils

To generate docutils documentation

  1. Select DocUtil task run/debug configuration, and change it as required: specify the configuration name, input and output directories, and optional keys.

  2. Launch this run/debug configuration, as described in the section Running Applications.

Generating Reference Documentation Using Sphinx

To create initial infrastructure for Sphinx documentation

  1. Ensure that the Sphinx package has been installed with the project interpreter (Settings/Preferences | Project <project name> | Project Interpreter). Refer to Installing, Uninstalling and Upgrading Packages for more information about how to install a package in PyCharm.

  2. On the main menu, choose Tools | Sphinx quickstart.

  3. If the Sphinx working directory is not specified in the Python Integrated Tools page, the Set working directory dialog box opens, suggesting to specify the path to the documentation.
    py sphinx working directory
  4. In the console that opens in PyCharm, answer the questions provided by the sphinx-quickstart utility. In particular, specify the source directory, where the generated conf.py file will be stored. If, answering this question, you just press Enter, PyCharm will use either the path you've specified in the previous step, or the path specified in the Sphinx working directory field of the Python Integrated Tools page.

To generate Sphinx documentation

  1. Select Sphinx task run/debug configuration, and change it as required: specify the configuration name, input and output directories.

  2. Launch this run/debug configuration, as described in the section Running Applications.

Last modified: 7 December 2018

See Also