Skip to main content

Auto-generate API documentation for Python projects.

Project description

pdoc

Build Status Code Coverage pdoc3 on PyPI

Auto-generate API documentation for Python 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) 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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pdoc3-0.5.3.tar.gz (56.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page