Cuneiform Documentation

System Requirements

In the cuneiform-doc directory run

virtualenv venv

This creates a directory venv that holds the virtual environment's data. To enter the virtual environment run

source venv/bin/activate

We can see that we are inside the virtual environment because the shell prompt has a (venv) prefix. Now, install the necessary software.

pip3 install sphinx

To leave the virtual environment run

deactivate

Enter the previously prepared virutal environment by sourcing its activate script

source venv/bin/activate

Build the static HTML site by entering

make html

Leave

deactivate

To upgrade the virtual environment, first enter it

source venv/bin/activate

Then install re-install sphinx with the --upgrade flag:

pip3 install --upgrade sphinx

Leave

deactivate