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. Refer to Install, uninstall, and upgrade packages for more information about how to install a package in P圜harm.įrom the main menu, choose Tools | Sphinx quickstart. Generating Reference Documentation Using Sphinx To create initial infrastructure for Sphinx documentationĮnsure that the Sphinx package has been installed with the Python interpreter ( Settings/Preferences | Project | Python Interpreter). Launch this run/debug configuration, as described in the section Run and rerun applications. Select DocUtil task run/debug configuration, and change it as required: specify the configuration name, input and output directories, and optional keys. Generating Reference Documentation Using DocUtils To generate docutils documentation P圜harm recognizes the docstring format and uses the documentation source directory defined in the Python Integrated Tools page of the Settings dialog. Refer to their respective download and installation pages for details. The documentation generators should be properly installed on your machine. P圜harm helps produce the formatted API documentation, using the following documentation generators: This feature is not available in the Educational edition of P圜harm.
