• Stars
    star
    1,124
  • Rank 41,395 (Top 0.9 %)
  • Language
    Python
  • License
    GNU Affero Genera...
  • Created almost 6 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

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.