Bug#1023927: RFP: python3-pdoc -- pdoc auto-generates API documentation that follows your project's Python module hierarchy. It requires no configuration, has first-class support for type annotations, cross-links between identifiers, comes with an integrated live-reloading web server, and understands numpydoc or Google-style docstrings.
Package: wnpp
Severity: wishlist
* Package name : python3-pdoc
Version : 12.2.2
Upstream Author : Maximilian Hils github@hi.ls
* URL : https://github.com/mitmproxy/pdoc
* License : Unlicense
Programming Lang: Python
Description : pdoc auto-generates API documentation that follows your project's Python module hierarchy. It requires no configuration, has first-class support for type annotations, cross-links between identifiers, comes with an integrated live-reloading web server, and understands numpydoc or Google-style docstrings.
It's a popular python package to auto generate html docs out of python docstrings.
Description from its own documentation:
"
What is pdoc?
pdoc auto-generates API documentation that follows your project's Python module hierarchy.
pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.
Easy setup, no configuration necessary.
Documentation is plain Markdown.
First-class support for type annotations.
Builtin web server with live reloading.
Customizable HTML templates.
Understands numpydoc and Google-style docstrings.
"
Reply to: