README.md

Uplift documentation

This repository is the documentation for Uplift.

The documentation is available here.

---

How to generate this documentation?

This documentation has been written with Sphinx, a Python documentation generator.

Installing Python and pip

The first thing that you need is Python and pip, its recommended tool for installing packages.

• On MacOS and Linux:

sudo easy_install pip

• On Windows:

Download the python installer and run it. It will install both Python and pip.

Installing Sphinx

You just need to run:

pip install sphinx==1.6.3

Generating the documentation

From the root of the project, simply run:

make html

It will generate the documentation in the HTML format. to generate it for another target, you can run make which will prompt the available targets.