
Security News
Open Source Maintainers Feeling the Weight of the EU’s Cyber Resilience Act
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
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 3 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.
Security News
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.