API Documentation for Python Projects.
pdoc -o ./html pdoc generates this website: pdoc.dev/docs.
pip install pdoc
pdoc is compatible with Python 3.9 and newer.
pdoc your_python_module
# or
pdoc ./my_project.py
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.
pdoc's main feature is a focus on simplicity: pdoc aims to do one thing and do it well.
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!
As an open source project, pdoc welcomes contributions of all forms.
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 someone has taken a project I built, relicensed it, attempted to erase its entry on the Python Wiki, released it under effectively the same name and, worst of all, associated it with Nazi symbols.
In contrast, the pdoc project strives to uphold a healthy community where everyone is treated with respect. Everyone is welcome to contribute as long as they adhere to basic civility. We expressly distance ourselves from the use of Nazi symbols and ideology.
The pdoc project was originally created by Andrew Gallant and is currently maintained by Maximilian Hils.
FAQs
API Documentation for Python Projects
We found that pdoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.