pdoc3

Auto-generate API documentation for Python projects.

AGPL-3.0 36 个版本 Python >=3.9

安装

pip install pdoc3

poetry add pdoc3

pipenv install pdoc3

conda install pdoc3

描述

pdoc

Auto-generate API documentation for Python 3+ projects.

Project website

Documentation

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.

分类

Development Status :: 5 - Production/Stable Environment :: Console Intended Audience :: Developers License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+) Operating System :: OS Independent Programming Language :: Python :: 3 :: Only Topic :: Documentation Topic :: Software Development :: Documentation Topic :: Utilities

版本列表

0.11.6 2025-03-20

0.11.5 2024-12-13

0.11.4 2024-12-13

0.11.3 2024-11-26

0.11.2 2024-11-26

0.11.1 2024-06-26

0.11.0 2024-06-22

0.10.0 2021-12-05

0.9.2 2020-11-27

0.9.1 2020-08-27

0.9.0 2020-08-27

0.8.5 2020-08-26

0.8.4 2020-07-15

0.8.3 2020-06-27

0.8.2 2020-06-26

0.8.1 2020-04-16

0.8.0 2020-04-15

0.7.5 2020-02-27

0.7.4 2020-01-17

0.7.3 2020-01-17

0.7.2 2019-11-13

0.7.1 2019-10-03

0.7.0 2019-09-26

0.6.4 2019-09-26

0.6.3 2019-07-03

0.6.2 2019-05-20

0.6.1 2019-05-05

0.6.0 2019-05-03

0.5.4 2019-04-21

0.5.3 2019-03-05

0.5.2 2019-02-04

0.5.1 2019-01-12

0.5.0 2019-01-10

0.3.13 2020-02-05

0.3.12 2020-02-03

0.3.11 2019-01-24