{"repo":"mitmproxy/pdoc","free":true,"listed":false,"github":"https://github.com/mitmproxy/pdoc","clone":"git clone https://github.com/mitmproxy/pdoc.git","description":"API Documentation for Python Projects","language":"Python","stars":2511,"topics":["documentation","python","docstrings","docs","pdoc","api-documentation","python3","api","docstring","documentation-tool"],"license":"MIT-0","category":"docs-static-sites","readme_excerpt":"API Documentation for Python Projects. Example pdoc -o ./html pdoc generates this website: pdoc.dev/docs. Installation pdoc is compatible with Python 3.10 and newer. Usage Run pdoc pdoc to see pdoc's own documentation, run pdoc --help to view the command line flags, or check our hosted copy of the documentation. Features pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well. Documentation is plain Markdown. First-class support for type annotations and all other modern Python 3 features. Builtin web server with live reloading. Customizable HTML templates. Understands numpydoc and Google-style docstrings. Standalone HTML output without additional dependencies. Under the hood... pdoc will automatically link identifiers in your docstrings to their corresponding documentation. pdoc respects your all variable when present. pdoc will traverse the abstract syntax tree to extract type annotations and docstrings from constructors as well. pdoc will automatically try to resolve type annotation string literals as forward references. pdoc will use inheritance to resolve type annotations and docstrings for class members. If you have substantially more complex documentation needs, we recommend using Sphinx! Contributing As an open source project, pdoc welcomes contributions of all forms. pdoc vs. pdoc3 This project is not associated with \"pdoc3\", which often falsely assumes our name. Quoting @BurntSushi, the original author of pdoc: I'm pretty disgusted that","default_branch":null,"files":null,"tree":[],"storefront":"/r/mitmproxy","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mitmproxy/pdoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}