This is the documentation source for IGL

The documentation template is based on Sphinx and Furo and requires Python and virtualenv.

The process described below works on the Mac. Building the documentation on Windows may require significant more work to adjust the version of the packages listed in the requirements.txt file. The process of building the documentation on Linux has not been tested.

1. Set up a Python virtual environment using virtualenv and activate it:

virtualenv venv
source ./venv/bin/activate

2. Once in the virtual environment, install the required Python packages:

pip install -r requirements.txt

3. Build the website using make.

make html

The generated website will be output to docs/build/html.