rUNSWift-Manual

Repository for maintaining the Sphinx Documentation for rUNSWift.

sudo apt install python3-sphinx-rtd-theme

To compile locally, run make html. The home documentation page can be opened by opening build/html/index.html in a browser.

The gh-pages branch is automatically generated by Travis-CI, whenever a push to the master branch happens. It contains the built html files. This is then uploaded to https://unswcomputing.github.io/rUNSWift-Manual/

The instructions for setting up the CI were here: https://purduecam2project.github.io/CAM2WebUI/basicSetup/sphinx.html

source/draw.io/ contains .png (with embedded XML) that can be imported/exported by draw.io. To modify a diagram,

1. import the png file into draw.io.
2. make ammendments.
3. overwrite png file by exporting from draw.io.