Auto-generate API documentation for Python projects.

These details have not been verified by PyPI

Project links

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), 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.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

0.11.1

Jun 26, 2024

0.11.0

Jun 22, 2024

This version

0.10.0

Aug 3, 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 3, 2019

0.7.0

Sep 26, 2019

0.6.4

Sep 26, 2019

0.6.3

Jul 3, 2019

0.6.2

May 20, 2019

0.6.1

May 5, 2019

0.6.0

May 3, 2019

0.5.4

Apr 21, 2019

0.5.3

Mar 5, 2019

0.5.2

Feb 4, 2019

0.5.1

Jan 12, 2019

0.5.0

Jan 10, 2019

0.3.13

Feb 5, 2020

0.3.12

Feb 3, 2020

0.3.11

Jan 24, 2019

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.10.0.tar.gz (86.1 kB view details)

Uploaded Aug 3, 2021 Source

Built Distribution

pdoc3-0.10.0-py3-none-any.whl (135.7 kB view details)

Uploaded Dec 5, 2021 Python 3

File details

Details for the file pdoc3-0.10.0.tar.gz.

File metadata

Download URL: pdoc3-0.10.0.tar.gz
Upload date: Aug 3, 2021
Size: 86.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3

File hashes

Hashes for pdoc3-0.10.0.tar.gz
Algorithm	Hash digest
SHA256	`5f22e7bcb969006738e1aa4219c75a32f34c2d62d46dc9d2fb2d3e0b0287e4b7`
MD5	`f47343746b21d3c2c6c2929b5899b514`
BLAKE2b-256	`95be69267c988fb7236cd60c452a4e7fb9a7991729476db490b634a07e7dfcdf`

See more details on using hashes here.

File details

Details for the file pdoc3-0.10.0-py3-none-any.whl.

File metadata

Download URL: pdoc3-0.10.0-py3-none-any.whl
Upload date: Dec 5, 2021
Size: 135.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2

File hashes

Hashes for pdoc3-0.10.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ba45d1ada1bd987427d2bf5cdec30b2631a3ff5fb01f6d0e77648a572ce6028b`
MD5	`f9d14e20c5f0fb5cd2aefc629f2de0d4`
BLAKE2b-256	`6736add16f4705689ed1f31aba24c973d035fc953c6fe54af9143837cc3b1315`