This repository contains the source files for the documentation for the Cider software package. The docs are exposed here. The Cider repository is here.
To update this documentation:
- Make changes to source
- Build the changes using jupyter-book
- Delete the contents of the
docs/
folder, and then copy the contents of_build/html/
intodocs/
. - Create an empty file called
.nojekyll
in thedocs/
folder. - Push your changes to your remote branch, then merge to the main branch of the repo. They should then be live within a couple of minutes. It's worth checking the live docs to make sure everything worked.