.. _build_doc:

Developer Guide - Documentation Build
*************************************

Create a Python Virtual environment
-----------------------------------

::

 wget http://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.3.2.tar.gz
 tar xvzf virtualenv-1.3.2.tar.gz
 cp virtualenv-1.3.2/virtualenv.py ./
 rm -rf virtualenv-1.3.2
 rm virtualenv-1.3.2.tar.gz
 mkdir venv
 python virtualenv.py venv
 source venv/bin/activate

Install Sphinx
--------------

::

 sudo apt-get install python-dev
 easy_install -U Sphinx

Generate the HTML docs
----------------------

::

 source venv/bin/activate
 cd path/to/doc/directory (where the Makefile is located)
 make html

This creates the HTML pages inside a .build directory

Generate PDF docs
-----------------

To generate pdf, install texlive and texlive-latex-extra

::

 make latex
 cd .build/latex
 make all-pdf