PyCharm 3.4.0 Web Help

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

Note

  • 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. On the main menu, choose Tools | Sphinx quickstart.
  2. If the Sphinx working directory is not specified in the Python Integrated Tools page, the Set working directory dialog box opens, suggesting you to specify the path to the documentation.

    py_sphinx_working_directory

    Note

    If the Sphinx working directory is specified in your project, this dialog will not appear.

  3. 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 EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter, 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.

Tip

The sphinx-quickstart utility is performed only once for a particular directory. If you want to generate the Sphinx infrastructure in a different directory, specify it 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.

See Also

Reference:

External Links:

Web Resources: