[mapserver-commits] r8659 - trunk/docs/development

[svn at osgeo.org]

Author: dmorissette
Date: 2009-03-08 11:31:00 -0400 (Sun, 08 Mar 2009)
New Revision: 8659

Modified:
   trunk/docs/development/documentation.txt
Log:
Added/updated Linux install/usage instructions

Modified: trunk/docs/development/documentation.txt
===================================================================
--- trunk/docs/development/documentation.txt	2009-03-08 14:56:25 UTC (rev 8658)
+++ trunk/docs/development/documentation.txt	2009-03-08 15:31:00 UTC (rev 8659)
@@ -64,13 +64,14 @@
       :Revision: $Revision$
       :Date: $Date$
 
-Installing Sphinx for rst-html Generation
------------------------------------------
+Installing and Using Sphinx for rst-html Generation
+---------------------------------------------------
 
+**On Windows:**
+
 #. install `Python 2.X`_
 #. download `setuptools`_ 
-#. For Windows users: make sure that the 'C:\Python2X\Scripts' 
-   directory is your path
+#. make sure that the 'C:\Python2X\Scripts' directory is your path
 #. execute the following at commandline:
 
    ::
@@ -88,10 +89,28 @@
      
    ...you should see a message: "build succeeded, ..."
    
-   Alternatively, if you are on \*nix, you can issue
 
+
+**On Linux:**
+
+#. make sure you have the Python dev and setuptools packages installed.
+   On Ubuntu:
+
    ::
 
+       sudo apt-get install python-dev
+       sudo apt-get install python-setuptools
+
+#. install sphinx using easy_install:
+
+   ::
+
+       sudo easy_install sphynx
+
+#. to process the docs, from the MapServer /docs directory, run:
+
+   ::
+
        make html
 
    or 
@@ -100,8 +119,9 @@
 
        make latex
 
-   to build the documentation using `make`.
+   the HTML output will be written to the build/html sub-directory.
 
+
 Reference Labels
 ----------------