Pdoc is vastly simpler to use than Sphinx for small projects, although the generated HTML is not as beautiful as Sphinx. Better to have uglier up-to-date docs than no docs or outdated docs.
In distinction from Sphinx, pdoc expects Markdown docstrings and does not parse RST docstrings.
pdoc is a light minimal install.
pip install pdoc
- From the top-level pymap3d/ directory, type
pdoc --html pymap3d
This creates several
*.m.htmlfiles under pymap3d/pymap3d, including
- Check the output by:
- If the output seems satisfactory,
move the files to the
gh-pagesbranch, or at least to a
mv pymap3d/*.html docs/
- In the Github repo Settings → Github Pages → Source: “master branch /docs folder”
- git commit and push. It takes a few seconds for Github Pages to deploy HTML.