Auto-generate API documentation for Python projects.
Project description
pdoc
Auto-generate API documentation for Python 3+ 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 and PEP 526 type annotations.
- pdoc respects
__all__when present. - Docstrings for overridden class members are inherited if unspecified.
- Support for documenting module, class, and instance variables by traversing ASTs.
- Automatic cross-linking of referenced identifiers.
- Overriding docstrings generation with special module-level
__pdoc__dictionary. - Easily extended and customized templates.
- Built-in development web server for near-instant preview of rendered docstrings.
The above features are explained in more detail in pdoc's documentation (generated with pdoc).
Development
Check CONTRIBUTING.md for hacking 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.11.0.tar.gz
(97.7 kB
view details)
File details
Details for the file pdoc3-0.11.0.tar.gz.
File metadata
- Download URL: pdoc3-0.11.0.tar.gz
- Upload date:
- Size: 97.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 12f28c6ee045ca8ad6a624b86d1982c51de20e83c0a721cd7b0933f44ae0a655 |
|
| MD5 | 9fc93dfecc27d7327526c8d6f72671a5 |
|
| BLAKE2b-256 | e14e741d6dbd64934c4769c055dd6952e1c6d117a1a25236f633e68ea2d375c8 |
