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.
- Support for PEP 484 type annotations.
- 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 and PDF.
- 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.6.1.tar.gz
(62.4 kB
view details)
File details
Details for the file pdoc3-0.6.1.tar.gz.
File metadata
- Download URL: pdoc3-0.6.1.tar.gz
- Upload date:
- Size: 62.4 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 | 24b4c012a89c573742a41f8239a71249060e3484baf16d4f489baec788313182 |
|
| MD5 | 5cbf1874cf2f2283f098672b3d507131 |
|
| BLAKE2b-256 | 6abaa53acee4609bcbc874e982dfd5a3b0630a6deffead2db86d3bfaafb517a3 |
