Skip to content

mapbender/mapbender-documentation

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
de
 
 
en
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Mapbender Documentation

This is the Mapbender documentation repository.

You can find the compiled pages of the latest released version at https://doc.mapbender.org/. Other versions of the documentation are also available at https://docs.mapbender.org/.

The sources are on Github.

The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.

You can find instructions on how the documentation is structured in chapter How to write Mapbender Documentation? or directly in this Git-Repository.

To build the website locally, you need to install Sphinx. Install it in Debian-based distributions via

sudo apt-get install sphinx-common python3-sphinx
sudo apt-get install pip3
sudo pip3 install sphinxcontrib-phpdomain

You can then build the documentation by running:

$ make

Example

cd /data
git clone git@github.com:mapbender/mapbender-documentation
git checkout release/3.2.0

ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc

rm -rf _build
sphinx-build . _build -A version=3.2.0

http://localhost/mb-doc/

To participate in the documentation, create a fork and submit a pull request with your changes.

Have fun!