Build the documentation website files
# install dependencies
pip install sphinx sphinx-autoapi sphinx-rtd-theme
# build docs
sphinx-build -b html source _build
Access the docs at build/index.html
.
For easy way to host the docs online, can try deploying using Github Pages.
I used the workflow described in: https://coderefinery.github.io/documentation/gh_workflow/
Please test the website locally before pushing to the remote main
branch.