Auto-generated Documentation via CI/CD

[ric-evans]

After #22, README contents are published to PyPI. This may not be enough documentation. If that's the case, look into auto-publishing "Read the Docs" style documentation in a similar (if not the same) GH Action as #22.

[ric-evans]

If we go this route, we can also add a "read the docs" badge: https://shields.io/category/build

[ric-evans]

Using pdoc + docs.icecube.aq/:

Make a GH Action Package with:

1. https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml#L16-L32
2. https://github.com/WIPACrepo/publication-web-db/blob/master/.github/workflows/pr.yml#L40-L45
   • with "@htmlcov.tar.gz" replaced by a tar of the HTML file-tree
   • replace path=$GITHUB_REPOSITORY/${{ github.head_ref }}/${{ github.sha }} with path=$GITHUB_REPOSITORY/v#.# and then add a redirect for docs.icecube.aq/$GITHUB_REPOSITORY
3. add a link to documentation on the README (as a badge?)

[dsschult]

There is also https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages. This might be nicer for larger projects, since you can have some overview pages in pure markdown.