[pgrouting-dev] Sphinx documentation update

[Stephen Woodbridge]

Hi Daniel,

I did a little more work on this. I added a cmake/FindSphinx.cmake file 
and as I mentioned before add -DWITH_DOC=ON target.

Also we have the README.md should this get renamed to rst and get build 
built as part of the doc.

So my plan for the"doc" directory it to have one file there that would 
be our index.rst -> index.html and this file would have a project 
overview and an index to other docs like:

project       - A more detailed project overview including PSC, source,
                 download links, listserv links, ...
users-guide   - Detailed doc on each major function and helper functions
tutorial      - List of tutorials and links (might be in subdirs)
gallery       - Standardized description and link to apps using pgr
presentations - List of presentations and links (might be in subdirs)
developers    - Developer standards, howtos
FAQ           - FAQ document
...           - other stuff as appropriate

Where each of these would be a subdirectory and would contain pages and 
or additional subdirs as needed.

But it still has some problems:

woodbri at maps:~/work/pgrouting$ cmake -H. -Bmybuild -DWITH_TSP=ON 
-DWITH_DD=ON -DWITH_DOC=ON
-- The C compiler identification is GNU 4.4.5
-- The CXX compiler identification is GNU 4.4.5
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- POSTGRESQL_EXECUTABLE is /usr/lib/postgresql/8.4/bin/postgres
-- POSTGRESQL_PG_CONFIG is /usr/bin/pg_config
-- Found PostgreSQL: /usr/include/postgresql/8.4/server, /usr/lib
-- Boost version: 1.42.0
Boost headers were found here: /usr/include
POSTGRESQL_VERSION_STRING is PostgreSQL 8.4.16
POSTGRESQL_VERSION is 8.4.16
Install directory for libraries is set to /usr/lib/postgresql/8.4/lib
Install directory for SQL files is set to /usr/share/pgrouting
-- Found Sphinx: /usr/bin/sphinx-build
Installation directory for libraries is set to 
/usr/lib/postgresql/8.4/lib and for SQL files is set to /usr/share/pgrouting
-- Found GAUL: /usr/local/lib/libgaul.so, /usr/local/lib/libgaul_util.so
Installation directory for libraries is set to /usr/lib/postgresql/8.4/lib
-- Found CGAL: /usr/include, /usr/lib/libCGAL.so, 
/usr/lib/libboost_thread.so, /usr/lib/libgmp.so
-- Configuring done
-- Generating done
-- Build files have been written to: /home/woodbri/work/pgrouting/mybuild
woodbri at maps:~/work/pgrouting$ cd mybuild/
woodbri at maps:~/work/pgrouting/mybuild$ make
Scanning dependencies of target trsp
[  6%] Building C object core/trsp/src/CMakeFiles/trsp.dir/trsp.c.o
[ 12%] Building CXX object core/trsp/src/CMakeFiles/trsp.dir/trsp_core.cpp.o
[ 18%] Building CXX object 
core/trsp/src/CMakeFiles/trsp.dir/GraphDefinition.cpp.o
[ 18%] Built target trsp
Scanning dependencies of target astar
[ 25%] Building C object core/astar/src/CMakeFiles/astar.dir/astar.c.o
[ 31%] Building CXX object 
core/astar/src/CMakeFiles/astar.dir/astar_boost_wrapper.cpp.o
[ 31%] Built target astar
Scanning dependencies of target dijkstra
[ 37%] Building C object 
core/dijkstra/src/CMakeFiles/dijkstra.dir/dijkstra.c.o
[ 43%] Building CXX object 
core/dijkstra/src/CMakeFiles/dijkstra.dir/boost_wrapper.cpp.o
[ 43%] Built target dijkstra
Scanning dependencies of target shooting_star
[ 50%] Building C object 
core/shooting_star/src/CMakeFiles/shooting_star.dir/shooting_star.c.o
[ 56%] Building CXX object 
core/shooting_star/src/CMakeFiles/shooting_star.dir/shooting_star_boost_wrapper.cpp.o
[ 56%] Built target shooting_star
Scanning dependencies of target routing
Linking CXX shared library lib/librouting.so
[ 56%] Built target routing
Scanning dependencies of target my_project_docs
[ 62%] Building HTML documentation with Sphinx
Making output directory...
/home/woodbri/work/pgrouting/doc/README.rst:109: WARNING: image file not 
readable: build/trsp-test-image.png
/home/woodbri/work/pgrouting/doc/index.rst:11: (WARNING/2) toctree 
references unknown document u'...'

WARNING: static directory 
'/home/woodbri/work/pgrouting/mybuild/doc/_build/_static' does not exist
[ 62%] Built target my_project_docs
Scanning dependencies of target routing_tsp
[ 68%] Building C object core/tsp/src/CMakeFiles/routing_tsp.dir/tsp.c.o
[ 75%] Building CXX object 
core/tsp/src/CMakeFiles/routing_tsp.dir/tsp_solver.cpp.o
Linking CXX shared library ../../../lib/librouting_tsp.so
[ 75%] Built target routing_tsp
Scanning dependencies of target routing_dd
[ 81%] Building C object 
core/driving_distance/src/CMakeFiles/routing_dd.dir/alpha.c.o
[ 87%] Building CXX object 
core/driving_distance/src/CMakeFiles/routing_dd.dir/alpha_drivedist.cpp.o
[ 93%] Building CXX object 
core/driving_distance/src/CMakeFiles/routing_dd.dir/boost_drivedist.cpp.o
[100%] Building C object 
core/driving_distance/src/CMakeFiles/routing_dd.dir/drivedist.c.o
Linking CXX shared library ../../../lib/librouting_dd.so
[100%] Built target routing_dd