Skip to content

joergen7/cuneiform-doc

Repository files navigation

Cuneiform Documentation

The source code for the Cuneiform website

System Requirements

Prepare a Virtual Environment

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

Build

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

Upgrade

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

Resources

Authors

License

Apache 2.0

About

Documentation for the Cuneiform programming language

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •