Browse files

explicitly make a docs/index page

git-svn-id: http://svn.osgeo.org/geotools/trunk@37043 e5c1c795-43da-0310-a71f-fac65c449510
  • Loading branch information...
1 parent 334cb5f commit 985bc1e53979048b6e62e79aa97f7665611ec1d4 jive committed May 2, 2011
Showing with 201 additions and 76 deletions.
  1. +72 −60 docs/build.xml
  2. +6 −0 docs/docs/conf.py
  3. +30 −0 docs/docs/index.rst
  4. +3 −2 docs/pom.xml
  5. +90 −14 docs/readme.txt
View
132 docs/build.xml
@@ -1,73 +1,85 @@
-<project name="docs" default="build">
+<project name="docs" default="build">
- <target name="build">
- <property environment="env"/>
- <condition property="sphinx.available">
- <or>
- <available file="sphinx-build" filepath="${env.PATH}"/>
- <available file="sphinx-build.exe" filepath="${env.Path}"/>
- <available file="sphinx-build.exe" filepath="${env.PATH}"/>
- </or>
- </condition>
- <condition property="rst2pdf.available">
- <or>
- <available file="rst2pdf" filepath="${env.PATH}"/>
- <available file="rst2pdf.exe" filepath="${env.Path}"/>
- <available file="rst2pdf.exe" filepath="${env.PATH}"/>
- </or>
- </condition>
- <condition property="latex.available">
- <or>
- <available file="latex" filepath="${env.PATH}"/>
- </or>
- </condition>
- <antcall target="sphinx">
- <param name="id" value="user"/>
- <param name="build" value="html"/>
- </antcall>
-
- <antcall target="sphinx">
- <param name="id" value="web"/>
- <param name="build" value="html"/>
- </antcall>
-
- <antcall target="sphinx">
- <param name="id" value="index"/>
- <param name="build" value="html"/>
- </antcall>
+ <target name="build">
+ <property environment="env"/>
+ <condition property="sphinx.available">
+ <or>
+ <available file="sphinx-build" filepath="${env.PATH}"/>
+ <available file="sphinx-build.exe" filepath="${env.Path}"/>
+ <available file="sphinx-build.exe" filepath="${env.PATH}"/>
+ </or>
+ </condition>
+ <condition property="rst2pdf.available">
+ <or>
+ <available file="rst2pdf" filepath="${env.PATH}"/>
+ <available file="rst2pdf.exe" filepath="${env.Path}"/>
+ <available file="rst2pdf.exe" filepath="${env.PATH}"/>
+ </or>
+ </condition>
+ <condition property="latex.available">
+ <or>
+ <available file="latex" filepath="${env.PATH}"/>
+ </or>
+ </condition>
+ <antcall target="sphinx-ignore-warnings">
+ <param name="id" value="docs"/>
+ <param name="build" value="html" />
+ </antcall>
+
+ <antcall target="sphinx">
+ <param name="id" value="user" />
+ <param name="build" value="html" />
+ </antcall>
+
+ <antcall target="sphinx">
+ <param name="id" value="web"/>
+ <param name="build" value="html"/>
+ </antcall>
- <!-- uncomment for developers guide -->
- <antcall target="sphinx">
- <param name="id" value="developer"/>
- <param name="build" value="html"/>
- </antcall>
- <!-- uncomment for pdf -->
- <!--antcall target="pdf">
+ <antcall target="sphinx">
+ <param name="id" value="index"/>
+ <param name="build" value="html"/>
+ </antcall>
+
+ <!-- uncomment for developers guide -->
+ <antcall target="sphinx">
+ <param name="id" value="developer"/>
+ <param name="build" value="html"/>
+ </antcall>
+ <!-- uncomment for pdf -->
+ <!--antcall target="pdf">
<param name="id" value="tutorial"/>
<param name="build" value="pdf"/>
</antcall-->
- <!--antcall target="latex">
+ <!--antcall target="latex">
<param name="id" value="tutorial"/>
<param name="build" value="latex"/>
</antcall-->
- </target>
+ </target>
+
- <target name="sphinx" if="sphinx.available">
- <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
- <arg line="-D release=${project.version} -a -W -E -b ${build} -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
- </exec>
- </target>
+ <target name="sphinx-ignore-warnings" if="sphinx.available">
+ <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
+ <arg line="-D release=${project.version} -a -E -b ${build} -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
+ </exec>
+ </target>
+
+ <target name="sphinx" if="sphinx.available">
+ <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
+ <arg line="-D release=${project.version} -a -W -E -b ${build} -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
+ </exec>
+ </target>
- <target name="latex" if="latex.available">
- <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
- <arg line="-D release=${project.version} -a -E -b latex -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
- </exec>
- </target>
+ <target name="latex" if="latex.available">
+ <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
+ <arg line="-D release=${project.version} -a -E -b latex -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
+ </exec>
+ </target>
- <target name="pdf" if="rst2pdf.available">
- <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
- <arg line="-D release=${project.version} -c ${basedir}/${id}/pdf -a -E -b pdf -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
- </exec>
- </target>
+ <target name="pdf" if="rst2pdf.available">
+ <exec executable="sphinx-build" failonerror="true" dir="${basedir}/${id}">
+ <arg line="-D release=${project.version} -c ${basedir}/${id}/pdf -a -E -b pdf -d &quot;${build.directory}/${id}/doctrees&quot; . &quot;${build.directory}/${id}/${build}&quot;"/>
+ </exec>
+ </target>
</project>
View
6 docs/docs/conf.py
@@ -0,0 +1,6 @@
+import sys, os
+sys.path.append(os.path.abspath('..'))
+from common import *
+
+html_theme='geotools'
+html_title='GeoTools Documentation'
View
30 docs/docs/index.rst
@@ -0,0 +1,30 @@
+GeoTools Documentation
+======================
+
+Quickstart to get up and running with GeoTools in minutes:
+
+* `Eclipse Quickstart <http://docs.geotools.org/latest/userguide/tutorial/quickstart/eclipse.html>`_ ( `stable <http://docs.geotools.org/stable/tutorials/quickstart/eclipse.html>`_ )
+* `NetBeans Quickstart <http://docs.geotools.org/latest/userguide/tutorial/quickstart/netbeans.html>`_ ( `stable <http://docs.geotools.org/stable/tutorials/quickstart/netbeans.html>`_ )
+
+GeoTools API
+------------
+
+GeoTools javadocs are `available online <http://docs.geotools.org/latest/javadocs/>`_ ( `stable <http://docs.geotools.org/stable/javadocs/>`_ )
+or `download <http://sourceforge.net/projects/geotools/files/>`_ them as a zip file.
+
+User Guide
+----------
+
+The GeoTools user guide is available online:
+
+`User Guide <http://docs.geotools.org/latest/userguide/>`_ ( `stable <http://docs.geotools.org/stable/userguide/>`_ )
+ Tutorials, module reference and examples illustrating the uses of GeoTools.
+
+ The user guide is also available for `download <http://sourceforge.net/projects/geotools/files/>`_
+ as a zip file.
+
+`Tutorials <http://docs.geotools.org/latest/tutorials/>`_ ( `stable <http://docs.geotools.org/stable/tutorials/>`_ )
+ Step by step tutorials intorducing both GeoTools and geospatial concepts for Java developers.
+
+`FAQ <http://docs.geotools.org/latest/userguide/faq.html>`_ ( `stable <http://docs.geotools.org/stable/userguide/faq.html>`_ )
+ Convey wisdom gleaned from the GeoTools user list.
View
5 docs/pom.xml
@@ -6,7 +6,8 @@
http://www.geotools.org/
Version: $Id: pom.xml 34196 2009-10-22 13:32:49Z groldan $
- ======================================================================= --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ ======================================================================= -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -226,7 +227,7 @@
<ant antfile="build.xml" dir="${basedir}" target="build">
<property name="build.directory" value="${build.directory}"/>
<!-- may be ${project.version} when tagged -->
- <property name="project.version" value="8.0-M1"/>
+ <property name="project.version" value="8.0-M0"/>
</ant>
</tasks>
</configuration>
View
104 docs/readme.txt
@@ -1,23 +1,99 @@
To build the docs for the first time....
-LINUX
+.. this is covered in the developers guide setup instructions in greater details.
-Make sure you have sphinx setup:
-1. sudo apt-get install python-dev
-2. sudo easy_install sphinx
+Windows Sphinx Install
+^^^^^^^^^^^^^^^^^^^^^^
-And then do a mvn build:
-3. mvn clean install
+Install Python:
-MAC
+1. Python version 2.7 has been verified to work: http://www.python.org/download/releases/2.7/
+2. You will need to add it to your path.::
+
+ set 'PYTHON=C:\Python27\'
+ set 'PATH=%PATH%;%PYTHON%'
-Make sure you have sphinx setup:
-1. Install the developer tools (there is installer on your operating system disk)
-2. easy_install sphinx
+3. You will need Setup Tools for Python 2.7
+
+ http://pypi.python.org/pypi/setuptools#downloads
+
+4. Install and add Setup Tools to your path::
+
+ run 'set SETUPTOOLS=C:\Python27\Scripts'
+ run 'set PATH=%PATH%;%SETUPTOOLS%'
-And then do a mvn build:
-3. mvn clean install
+5. Install Sphinx::
+
+ easy_install sphinx
+
+ Optionally you could install a specific version of sphinx (although we try and use the latest)::
+
+ easy_install sphinx==1.0.7
-WINDOWS
+rst2pdf Optional Install
+^^^^^^^^^^^^^^^^^^^^^^^^
-Not yet
+You can optionally install rst2pdf to build pdf documentation:
+
+1. Install Visual Studio 2008 Express Edition (this provides windows with a C compiler). It is a free download on the Microsoft site.
+ You need to be sure to use the 2008 edition so that easy_install will compile something that can actually be linked to the Python executable.
+
+2. Use easy install to produce rst2pdf::
+
+ easy_install rst2pdf
+
+3. This depends on the Python Image Library (which it can probably build now that you have a compiler).
+4. If you cannot manage to build you can download a precompiled Python Image Library (PIL) from here:
+
+ * http://effbot.org/downloads/#pil (download the one for python 2.7)
+
+Mac Sphinx Install
+^^^^^^^^^^^^^^^^^^
+
+You can use the distribution manager of your choice (example bru, macports, etc...). The following example
+is for macports.
+
+1. On OSX Use macports to install Python 2.7::
+
+ sudo port install python27
+ sudo port install python_select
+ sudo python_select python27
+
+2. You can use macports to install Python Image Library::
+
+ sudo port install py27-pil
+
+3. You can now use python easy_install to install sphinx::
+
+ sudo easy_install sphinx
+
+ Optionally you could ask for a specific version (we try and use the latest)::
+
+ sudo easy_install sphinx==1.0.7
+
+4. To build the PDF targets you will also need rst2pdf.::
+
+ sudo easy_install rst2pdf
+
+5. If you uses easy_install to grab the python image library it easy to get compile errors.
+
+
+Linux Sphinx Install
+^^^^^^^^^^^^^^^^^^^^
+
+Use apt-get and easy install.
+
+1. Python is usually available by default, if not::
+
+ apt-get install Python
+
+ You may need to use sudo (if for example you are on unbuntu)
+
+2. Use easy_install to graph sphinx (using sudo if required)::
+
+ easy_install sphinx
+
+ Optionally you can install a specifc version::
+
+ easy_install sphinx==1.0.7
+

0 comments on commit 985bc1e

Please sign in to comment.