pdoc ====

Auto-generate API documentation for Python 3+ projects.

Project website

[Documentation]

[Documentation]: https://pdoc3.github.io/pdoc/doc/pdoc/

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

[docstrings formats]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-docstring-formats [reST directives]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-rest-directives [PEP 484]: https://www.python.org/dev/peps/pep-0484/ [PEP 526]: https://www.python.org/dev/peps/pep-0526/ [all]: https://pdoc3.github.io/pdoc/doc/pdoc/#what-objects-are-documented [inherited]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-inheritance [variables]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-for-variables [cross-linking]: https://pdoc3.github.io/pdoc/doc/pdoc/#linking-to-other-identifiers [pdoc dictionary]: https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-pdoc [customized templates]: https://pdoc3.github.io/pdoc/doc/pdoc/#custom-templates [development web server]: https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface

Development

---

Check CONTRIBUTING.md for hacking details.