1
0
Fork 0
Documentation of OSGeoLive project
 
 
 
 
 
 
Go to file
Angelos Tzotsos 9df1702fe0 Updated version 2017-07-21 11:04:42 +03:00
MacInstallers Fix #1102 Top level links in Win/Mac Installers dir don't work. 2013-02-14 20:04:02 +00:00
WindowsInstallers Fix #1102 Top level links in Win/Mac Installers dir don't work. 2013-02-14 20:04:02 +00:00
bin Add image compression logic to Makefile 2017-07-12 20:44:23 +02:00
ca fixing the index files glob 2017-07-18 10:05:44 -05:00
de removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
debian Updating debian changelog for rc1 2017-07-21 11:03:37 +03:00
el removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
en touchup 2017-07-20 14:00:28 -07:00
es removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
fr removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
hu removing more errors on hu docs 2017-07-18 10:07:08 -05:00
id Replace http with https in creative common links 2017-07-14 21:55:22 +02:00
images Fixed desktop screenshots for 11.0 2017-07-21 11:00:18 +03:00
it removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
ja removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
ko removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
pl removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
retired_docs Moving mapguide images 2017-07-16 19:16:27 -05:00
reveal.js Updated reveal.js to 3.3.0 2016-08-22 21:31:25 +03:00
ru removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
themes removing the gray background and border on local contents 2017-07-09 11:53:55 -05:00
zh removing the sponsor images on all languages following the style made by Jody on the English version 2017-07-18 20:04:29 -05:00
.gitignore adding a .gitignore file 2017-06-20 11:11:56 -05:00
.travis.yml trying with exit 1 2017-07-13 21:15:27 -05:00
Makefile changed the name to prior_applications.rst 2017-07-15 18:54:35 -05:00
README.txt Update README for switch from SVN to Git. 2016-07-21 18:37:53 +02:00
VERSION.txt Updated version 2017-07-21 11:04:42 +03:00
conf.py Merge pull request #284 from cvvergara/add-left-logo 2017-07-12 20:59:56 +00:00
contributors-transform-git.txt update name and email for git migration 2015-02-06 12:58:57 +00:00
contributors.csv update contributors for dbb 2017-07-10 08:13:02 -07:00
contributors.rst changed column width (value in percent) 2012-04-15 11:39:47 +00:00
index.template build support for Bahasa Indonesia translations 2013-06-27 03:42:42 +00:00
index_pdf.template fix pdf and html documentation adding new templates 2012-12-15 04:31:57 +00:00
licenses.csv adding generated licenses.csv to visualize changes 2017-06-20 08:19:54 -05:00
osgeo_contact.rst upper case 2013-01-31 11:25:12 +00:00
osgeolive.css Document use of dd to write isohybrid+UEFI ISO images to USB drive 2017-01-23 18:32:47 +13:00
passwords.txt avoid deegree starting firefox as root (#1389), and other deegree cleanups 2014-08-14 23:51:42 +00:00
settings.py Updated iso and vm size 2017-03-12 20:26:26 +02:00
tocompress.txt Update images to compress 2017-07-12 20:44:23 +02:00
translators.csv Merge pull request #159 from gevos/master 2016-08-27 13:47:51 +03:00
translators.rst changed column width (value in percent) 2012-04-15 11:42:16 +00:00

README.txt

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
::
   git clone https://github.com/OSGeo/OSGeoLive-doc.git
   cd OSGeoLive-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/