Auto-generate API documentation for Python projects.
Project Links
Meta
Requires Python: >= 3.9
Classifiers
Topic
- Documentation
- Software Development :: Documentation
- Utilities
License
- OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Development Status
- 5 - Production/Stable
Environment
- Console
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
- Python :: 3 :: Only
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.
0.11.6
Mar 20, 2025
0.11.5
Dec 13, 2024
0.11.4
Dec 13, 2024
0.11.3
Nov 26, 2024
0.11.2
Nov 26, 2024
0.11.1
Jun 26, 2024
0.11.0
Jun 22, 2024
0.10.0
Aug 03, 2021
0.9.2
Nov 27, 2020
0.9.1
Aug 27, 2020
0.9.0
Aug 27, 2020
0.8.5
Aug 26, 2020
0.8.4
Jul 15, 2020
0.8.3
Jun 27, 2020
0.8.2
Jun 26, 2020
0.8.1
Apr 16, 2020
0.8.0
Apr 15, 2020
0.7.5
Feb 27, 2020
0.7.4
Jan 17, 2020
0.7.3
Jan 17, 2020
0.7.2
Nov 13, 2019
0.7.1
Oct 03, 2019
0.7.0
Sep 26, 2019
0.6.4
Sep 26, 2019
0.6.3
Jul 03, 2019
0.6.2
May 20, 2019
0.6.1
May 05, 2019
0.6.0
May 03, 2019
0.5.4
Apr 21, 2019
0.5.3
Mar 05, 2019
0.5.2
Feb 04, 2019
0.5.1
Jan 12, 2019
0.5.0
Jan 10, 2019
0.3.13
Feb 05, 2020
0.3.12
Feb 03, 2020
0.3.11
Jan 24, 2019
