Skip to content
Documentation of OSGeoLive project.
Shell CMake Perl
Branch: master
Clone or download
camerons Merge pull request #578 from camerons/presentation-note
Add note that some browsers prevent our presentation notes popup
Latest commit 08571fc Feb 13, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.tx [locale] updating changes on locale strings Aug 6, 2019
cmake [build] fixing FindSphinx.cmake to work with python3 Nov 27, 2018
debian Recommend fonts-noto-cjk instead of Depending on it Aug 31, 2019
doc Apply suggestions from code review Feb 13, 2020
locale [locale] adding some missing changes on files Aug 14, 2019
scripts Revert erroneously committed change Jun 4, 2019
.gitignore
.travis.yml [publish][fi] publishing new language Aug 7, 2019
CMakeLists.txt
LICENSE.txt new file for LICENSE taken from https://live.osgeo.org/en/copyright.html Mar 24, 2018
README.rst Added contributing section to the README Nov 20, 2019
VERSION.txt Preparing 13.0 release Aug 7, 2019
appveyor.yml Fix requirements syntax Nov 19, 2019
compile Updated overview of INSPIRE and OGC Jul 25, 2018
contributors-transform-git.txt update name and email for git migration Feb 6, 2015
contributors.csv Added FelicityBrand to contributors Oct 16, 2019
index_pdf.template fix pdf and html documentation adding new templates Dec 15, 2012
licenses.csv changing instances OSGeo-Live -> OSGeoLive on the locale directory Nov 7, 2017
projects_info.csv
requirements.txt adding a requirements file Mar 27, 2018
tocompress.txt Update images to compress Jul 12, 2017
translators.csv Adding Alin Deneanu (Romania) Aug 31, 2019

README.rst

Building OSGeoLive documentation

The following steps describe how to build OSGeoLive documentation on an Ubuntu based operating system (such as Lubuntu).

https://osgeo.github.io/OSGeoLive-doc/ - automated publication of latest docs from GitHub

About OSGeoLive

OSGeoLive is a self-contained bootable DVD, USB thumb drive or Virtual Machine based on Lubuntu, that allows you to try a wide variety of open source geospatial software without installing anything. It is composed entirely of free software, allowing it to be freely distributed, duplicated and passed around.

reStructured Text

The majority of OSGeoLive documentation is generated from reStructured text (reSt) sources using Sphinx. reSt is similar to wiki markup, and readable in plain ascii. As a quick check, github will (partially) render reSt documents as HTML.

Build steps

1.1 Install python and sphinx version 1.6.5 or greater (as provided with Ubuntu >16.04), (install_main_docs.sh does this too)

For Python 2

cd /root/of/repo

# Install pip
sudo apt-get install python-pip

# Prepare python environment
pip install virtualenv
virtualenv py-env

# activate the environment
source py-env/bin/activate

# install the requirements
pip install sphinx==1.6.5
pip install sphinx-intl
pip install sphinxjp.themes.revealjs

# Requirements for the presentation
sudo apt-get install cpanminus
sudo cpanm Text::SimpleTable::AutoWidth

For Python 3

cd /root/of/repo

# Install pip
sudo apt-get install python3-pip
sudo apt-get install python3-venv

# Prepare python environment
python3 -m venv py-env

# activate the environment
source py-env/bin/activate

# install the requirements
pip install sphinx==1.6.5
pip install sphinx-intl
pip install sphinxjp.themes.revealjs

# Requirements for the presentation
sudo apt-get install cpanminus
sudo cpanm Text::SimpleTable::AutoWidth
1.2 Install the requirements
sudo pip install sphinx==1.6.5 sudo pip install sphinx-intl sudo pip install sphinxjp.themes.revealjs sudo apt-get install cpanminus sudo cpanm Text::SimpleTable::AutoWidth

2. Clone or download OSGeoLive source documentation

git clone https://github.com/OSGeo/OSGeoLive-doc.git

3. Generate the English documentation

cd OSGeoLive-doc
mkdir build
cd build
cmake -DHTML=ON ..
make
cd ..

The output is in build/doc/_build/html/

4. Generate another language documentation

mkdir build
cd build
cmake -DHTML=ON -DFR=ON ..
make
cd ..

Adding -DFR=ON adds the French language, adding another -DES=ON adds Spanish, and so on. The output is also in build/doc/_build/html/

5. Optional: reduce the size of the generated documentation

bash scripts/clean-images.sh

Contributing:

Information about how to document the projects on OSGeoLive can be found on the OSGeoLive wiki: https://trac.osgeo.org/osgeolive/wiki

References:

You can’t perform that action at this time.