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.
1 maintainer
Metadata
1 maintainer
Release files for pdoc3 0.11.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pdoc3-0.11.6.tar.gz | 177.1 kB | Without provenance | Details for pdoc3-0.11.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pdoc3-0.11.6-py3-none-any.whl | Python 3 | none | any | Details for pdoc3-0.11.6-py3-none-any.whl |
Total release size: 432.3 kB
Release files / pdoc3-0.11.6.tar.gz
| Download URL | pdoc3-0.11.6.tar.gz |
|---|---|
| Size | 177.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1ea5e84b87a754d191fb64bf5e517ca6c50d0d84a614c1efecf6b46d290ae387
|
|
BLAKE2b-256 checksum How to use checksums |
edf007d8b771b99c16a06741cd7b2639494a15357df819ecf899c33b87db6257
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.2
|
Release files / pdoc3-0.11.6-py3-none-any.whl
| Download URL | pdoc3-0.11.6-py3-none-any.whl |
|---|---|
| Size | 255.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8b72723767bd48d899812d2aec8375fc1c3476e179455db0b4575e6dccb44b93
|
|
BLAKE2b-256 checksum How to use checksums |
df98629f269c2bd91bdcac147aad5cf51ceb645c0196e23a41ee3c051125190f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.2
|
Security for pdoc3 0.11.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
