Auto-generate API documentation for Python projects.
Pdoc will accept a Python module file, package directory or an import path.
$ pdoc your_project
pdoc --help for more command-line switches and the
documentation for more
Simple usage. Generate sensible API (+ prose) documentation without any special configuration.
Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings) and some reST directives.
Inheritance used as applicable for inferring docstrings for class members.
Support for documenting module, class, and instance variables by traversing ASTs.
Automatic cross-linking of referenced identifiers in HTML.
Overriding docstrings with special module-level
Built-in development web server for near instant preview of rendered docstrings.
The above features are explained in more detail in pdoc’s documentation (which was generated with pdoc).
pdoc includes a feature-rich “binary” program for producing HTML and plain text documentation of your modules.
To produce HTML documentation of your whole package in subdirectory ‘build’ of the current directory, using the default HTML template, run: