Python 3 - Second Edition

37.2    Automatically Generated Documentation: pydoc

The pydoc module of the standard library contains a script called pydoc or pydoc3, which is used to automatically generate program documentation.

Note

On Windows, the pydoc script may not be entered in the system path for executable files. In this case, you’ll find it in the Tools subfolder of the Python installation.

In the simplest case, you call pydoc with the modules you want to document as parameters. A prerequisite for successful documentation generation is that the passed modules can be imported by Python. The modules must therefore be located in the local working directory or in one of the directories entered in sys.path. As an example, we’ll now generate the documentation of the ...