Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
36 lines (19 sloc) 978 Bytes

README: building VoteIT project user documentation

This is instructions for building the documentation. If you're a regular user and just want to read the manual, go back to: #TODO XXX

How to install and build a local environment. You'll need python 2.7 or similar and have setuptools + virtualenv installed. You'll also need make, or run the sphinx commands by hand.

  1. Use virtualenv to create a local python within this directory and install sphinx
virtualenv .
bin/easy_install Sphinx

2. Build the documentation you'd like to work with. Each is located in it's respective directory. There will be a Makefile present in the one you'll use.

The root of this repository is the manual main page. Check under languages for each specific language.

Simply run:

make html
  1. Locate the build documentation - it will be in a directory called _build.