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 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.8.3.tar.gz
(77.7 kB
view details)
File details
Details for the file pdoc3-0.8.3.tar.gz.
File metadata
- Download URL: pdoc3-0.8.3.tar.gz
- Upload date:
- Size: 77.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19bd1a72e1c82875a6927b244aca826dedb635ea2a7a36ac62cbe063a8ddc30d |
|
| MD5 | 2c2210816fefa1d44d5c2758f1f8cd96 |
|
| BLAKE2b-256 | 1bae0bf8314a56ba26fa701f89b50542e0306a2097fe08aed5eb6098fe79925a |
