Auto-generate API documentation for Python projects.
Project description
pdoc
Auto-generate API documentation for Python projects.
Installation
$ pip install pdoc3
Usage
Pdoc will accept a Python module file, package directory or an import path.
$ pdoc your_project
See pdoc --help
for more command-line switches and the documentation
for more usage examples.
Features
- Simple usage. Generate sensible API (+ prose) documentation without any special configuration.
- Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings), LaTeX math, and some reST directives.
- Support for PEP 484 type annotations.
- pdoc respects
__all__
when present. - 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 and PDF.
- Overriding docstrings with special module-level
__pdoc__
dictionary. - 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).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pdoc3-0.7.2.tar.gz
(68.3 kB
view hashes)