Skip to content
master
Switch branches/tags
Code

Latest commit

* Add to `pdoc.test.Docformats.test_reST_include` to catch issue.

* Add a single line-break at the end of `.. include::`ed files - except for when in a code block.

* Minor change comment

* Revert last 2 commits.

* Don't consume trailing newline from reST directives.

* [] itself a disjunctive list of characters
2cce30a

Git stats

Files

Permalink
Failed to load latest commit information.

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.