Closed
Description
Hi everyone (particularly recent contributors @till-m, @fmfn, @leandrobbraga)
I've set up the html docs to build through github workflows and build to a github page. every time there is a push to main branch, the docs will be rebuilt and place on the gh-pages branch.
You can view the result here.
I haven't updated the repo description with this link yet because I think there's still some work to be done. I want to use this thread to keep track of the things we need to update:
- make sure image links are working
- review docstrings which are used to build code docs
- write a new notebook 'how it works' and remove a lot of this information from the readme.