[Mapbender_dev] Mapbender3 documentation with rst-file and Sphinx

[Karim Malhas]

Thumbs up for RST, from me.

On Fri, Feb 24, 2012 at 09:55:22AM +0100, Astrid Emde wrote:
> Hello devs,
> 
> Christian and I discussed about how to write the Mapbedner3
> documentation for workshops.
> 
> My idea was to write the documentation in rst like it is done in the
> OSGeo-Live-project [1]. I wrote the documentation for Mapbender
> 2.7.x like this [2]
> 
> We would write a rst-textfile which we can compile to html or pdf
> with Sphinx [3]. We can keep this file at github and Christian
> mentioned that github supports rst-files and can display them as
> html.
> 
> This is how the rst-file looks for mapbender_quickstart.rst in
> OSGeo-Live [4].
> 
> An advantage would be that we could easily provide the documentation
> for OSGeo-Live if we want to add Mapbender3 to the OSGeo-Live
> project. And also we can easily use the documentation as a template
> for customized workshops.
> 
> What do you think about this idea?
> 
> [1] http://live.osgeo.org/en/index.html
> [2] http://live.osgeo.org/en/overview/mapbender_overview.html
> [3] http://sphinx.pocoo.org/rest.html
> [4] http://trac.osgeo.org/osgeo/browser/livedvd/gisvm/trunk/doc/de/quickstart/mapbender_quickstart.rst
> 
> 
> 
> -- 
> Best regards
> 
> Astrid Emde
> 
> ********************************************
> FOSSGIS Konferenz 2012
> 20.-22. März 2012 in Dessau
> http://www.fossgis.de/konferenz/2012
> ********************************************
> ----------------------------------
> 
>  Astrid Emde
>  WhereGroup GmbH&  Co.KG
>  Eifelstraße 7
>  53119 Bonn
>  Germany
> 
>  Fon: +49(0)228 90 90 38 - 19
>  Fax: +49(0)228 90 90 38 - 11
> 
>  astrid.emde at wheregroup.com
>  www.wheregroup.com
> 
> Amtsgericht Bonn, HRA 6788
> -------------------------------
> Komplementärin:
> WhereGroup Verwaltungs GmbH
> vertreten durch:
> Olaf Knopp, Peter Stamm
> -------------------------------
>  pgp-public key:
>  http://pgp.mit.edu:11371/pks/lookup?search=0x06DA52D72D515284
>   Signierte und/oder verschlüsselte Nachrichten sind sehr willkommen
>   Signed and/or encrypted mail is highly appreciated
> 
> _______________________________________________
> Mapbender_dev mailing list
> Mapbender_dev at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/mapbender_dev
>