[Mapbender_dev] Mapbender3 documentation with rst-file and Sphinx

[Andreas Schmitz]

Astrid Emde wrote:

Hi,

> 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?

I think it's a good choice. We've also played around with sphinx a bit
for deegree and found it to be quite suitable, looks like we're going to
use it for our handbook as well.

Best regards,
Andreas Schmitz
-- 
Occam Labs UG (haftungsbeschränkt)
Godesberger Allee 139
53175 Bonn, Germany
+49 228 937 988 65
http://www.occamlabs.de
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
Url : http://lists.osgeo.org/pipermail/mapbender_dev/attachments/20120224/6d56c845/attachment.bin