.. -*- restructuredtext -*-

==================================================
README for Creating Inteproxy Server Documentation 
==================================================


Requirements
============

You need Sphinx to compile the documentation. Sphinx is available as an
easy-installable package [1] on the Python Package Index [2].::

  easy_install -U Sphinx


Compiling the documentation
===========================

Use ``make html`` to create the html version of the InteProxy Server
documentation.

Or use ``make latex`` to create the latex version of the documentation.  After
creating the latex version, you can create a pdf document by simply use:::

  cd build/latex; make all-pdf; cd -

Or use ``make latexpdf`` to create the latex PDF version of the documentation. 


Reading the docs
================

For the html version direct your browser to ``build/html/index.html``.  You
will find the pdf document in ``build/latex`` directory.


Check links in the docs
=======================

Don't forget to check links in the document before handed out.

  make linkcheck

Links
=====

[1] http://peak.telecommunity.com/DevCenter/EasyInstall
[2] http://pypi.python.org/pypi/Sphinx