Auto-generate API documentation for Python projects.
$ pip install pdoc3
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.
- 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 type annotations.
- 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 and PDF.
- 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).
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent