[Inteproxy-commits] r236 - trunk/server/doc

[scm-commit@wald.intevation.org]

Author: bjoern
Date: 2010-03-19 09:26:08 +0100 (Fri, 19 Mar 2010)
New Revision: 236

Added:
   trunk/server/doc/README.txt
Log:
Added README for how to compile the InteProxy Server documentation.


Added: trunk/server/doc/README.txt
===================================================================
--- trunk/server/doc/README.txt	2010-03-18 18:31:14 UTC (rev 235)
+++ trunk/server/doc/README.txt	2010-03-19 08:26:08 UTC (rev 236)
@@ -0,0 +1,40 @@
+.. -*- 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 -
+
+
+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.
+
+
+Links
+=====
+
+[1] http://peak.telecommunity.com/DevCenter/EasyInstall
+[2] http://pypi.python.org/pypi/Sphinx