pdoc definition

Contents

• pdoc definition

  • https://github.com/pdoc3/pdoc

  • README.md pdoc

    • Installation

    • Usage

    • Features

  • pdoc cli

https://github.com/pdoc3/pdoc

Auto-generate API documentation for Python projects.

README.md pdoc

See also

• https://github.com/pdoc3/pdoc/blob/master/README.md

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

pdoc cli

See also

• https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface

pdoc includes a feature-rich “binary” program for producing HTML and plain text documentation of your modules.

To produce HTML documentation of your whole package in subdirectory ‘build’ of the current directory, using the default HTML template, run: