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.6.tar.gz
(177.1 kB
view details)
Built Distribution
pdoc3-0.11.6-py3-none-any.whl
(255.2 kB
view details)
File details
Details for the file pdoc3-0.11.6.tar.gz.
File metadata
- Download URL: pdoc3-0.11.6.tar.gz
- Upload date:
- Size: 177.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ea5e84b87a754d191fb64bf5e517ca6c50d0d84a614c1efecf6b46d290ae387
|
|
| MD5 |
2a58a9e00b0b941c0814c9fcea6173d8
|
|
| BLAKE2b-256 |
edf007d8b771b99c16a06741cd7b2639494a15357df819ecf899c33b87db6257
|
File details
Details for the file pdoc3-0.11.6-py3-none-any.whl.
File metadata
- Download URL: pdoc3-0.11.6-py3-none-any.whl
- Upload date:
- Size: 255.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b72723767bd48d899812d2aec8375fc1c3476e179455db0b4575e6dccb44b93
|
|
| MD5 |
81bf4aaf6be07b49330c13aa62d7f847
|
|
| BLAKE2b-256 |
df98629f269c2bd91bdcac147aad5cf51ceb645c0196e23a41ee3c051125190f
|
