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) and some reST directives.
- 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.
- 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).
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.5.3.tar.gz
(56.6 kB
view details)
File details
Details for the file pdoc3-0.5.3.tar.gz.
File metadata
- Download URL: pdoc3-0.5.3.tar.gz
- Upload date:
- Size: 56.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8e11ef161c3dcd68d5a434d38ae55e2f8f5719470429d64e9b187d87e5f1d8d6 |
|
| MD5 | a7118a121e34c188b62b5ef7de4a8f5d |
|
| BLAKE2b-256 | 85dd860a5305706f7e728912ad446b5b5ba1bebd6ee9f8e92c29456b1ab5b734 |
