Pdoc Python quickstart
Pdoc is vastly simpler to use than Sphinx for small projects, with good HTML formatting.
In distinction from Sphinx, pdoc does not parse RST docstrings, but Pdoc does allow the following docstring formats:
- Google-style docstrings
At this time, pdoc3 doesn’t consider Python type hinting.
pdoc is a light minimal install.
pip install pdoc3
We use the
with auto-generated docs
as an example.
From the top-level pymap3d/ directory, type
pdoc --html pymap3d
This creates several
*.html files under
Check the output by:
If the output seems satisfactory,
move the files to the
or at least to a
mv html/pymap3d/*.html docs/
Publish the docs to the web by:
- In the Github repo Settings → Github Pages → Source: “gh-pages”
- git commit and push. It takes a few seconds for Github Pages to deploy HTML.