Documentation source for Animate, Goalie, and Movement

This repository holds the source code used to generate the documentation pages for Animate, Goalie, and Movement, including long-form documentation, demos, and API documentation.

The public website build can be found at https://mesh-adaptation.github.io.

Building the documentation

The documentation pages are built using Sphinx. If your Python virtual environment does not already have Sphinx installed then install it using the following command:

python3 -m pip install -r requirements.txt

The default method of generation is as HTML - this is used for the website build. To generate the documentation locally, run the demos for each package and then use the make html command. This can be achieved as follows:

cd docs
make run_animate_demos
make run_goalie_demos
make run_movement_demos
make html