GitHub - OSGeo-live/OSGeoLive-doc: Documentation of OSGeoLive project.

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 4,977 Commits
MacInstallers		MacInstallers
WindowsInstallers		WindowsInstallers
bin		bin
ca		ca
de		de
debian		debian
el		el
en		en
es		es
fr		fr
hu		hu
id		id
images		images
it		it
ja		ja
ko		ko
pl		pl
reveal.js		reveal.js
ru		ru
themes		themes
zh		zh
Makefile		Makefile
README.txt		README.txt
VERSION.txt		VERSION.txt
conf.py		conf.py
contributors-transform-git.txt		contributors-transform-git.txt
contributors.csv		contributors.csv
contributors.rst		contributors.rst
index.template		index.template
index_pdf.template		index_pdf.template
osgeo_contact.rst		osgeo_contact.rst
osgeolive.css		osgeolive.css
passwords.txt		passwords.txt
settings.py		settings.py
translators.csv		translators.csv
translators.rst		translators.rst

Repository files navigation

HTML

Explain here how the index.html is automatically constructed.

reStructured Text
=================

The majority of our documentation is generated from reStructured text
sources using Sphinx. reSt is similar to wiki markup, and readable in
plain ascii. As a quick check, the Trac system viewer will (partially)
render reSt documents as HTML from the online SVN browser.

1. Install python and sphinx version 0.6.4 or greater (as provided with Ubuntu 10.04), (install_main_docs.sh does this too)
::
   sudo apt-get install python-sphinx

2. The included make file will generate the documentation
::
   cd trunk/doc
   make html

   View output in _build/html/en/index.html


References:
~~~~~~~~~~~

* http://wiki.osgeo.org/wiki/Live_GIS_Add_Project#Application_Overview

* http://sphinx.pocoo.org

* http://docutils.sf.net/rst.html

* http://matplotlib.sourceforge.net/sampledoc/