Sphinx documentation

[ma595]

Sphinx

• https://coderefinery.github.io/documentation/gh_workflow/
• https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/

Commenting Type hinting Docstrings

[ma595]

Initial attempt at Sphinx docs that rebuilds on push using github actions. Hosted using github pages using Sphinx Alabaster theme. API docs are auto-generated with:

sphinx-apidoc -o ./docs/source/ detectree2/

This requires building detectree2 (CPU only), which takes ~5mins in github actions. The pip install will be replaced once conda/poetry packaging is complete.

• should it be rebuilt and redeployed on every push?
• Can we point to pre-built .whl or tar.gz instead (as shown here)? https://newbedev.com/using-github-actions-to-publish-documentation
• Poetry? https://tomasfarias.dev/posts/sphinx-docs-with-poetry-and-github-pages/
• improved docstrings? https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/

[ma595]

https://coderefinery.github.io/documentation/gh_workflow/

[ma595]

https://ma595.github.io/detectree2/ Hosted using my fork: https://github.com/ma595/detectree2

https://coderefinery.github.io/documentation/gh_workflow/ github.com/patball1/detectree2/settings/pages https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site