Skip to content
forked from pdoc3/pdoc

🐍 ➡️ 📜 Auto-generate API documentation for Python projects

License

Notifications You must be signed in to change notification settings

silverbucket/pdoc

 
 

Repository files navigation

pdoc

Build Status Code Coverage pdoc3 on PyPI package downloads GitHub Sponsors

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

The above features are explained in more detail in pdoc's documentation (generated with pdoc).

Development

Check CONTRIBUTING.md for hacking details.

About

🐍 ➡️ 📜 Auto-generate API documentation for Python projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 81.5%
  • Mako 17.9%
  • Shell 0.6%