[Qgis-developer] proposal for migrating QGIS documentation to reST/Sphinx

[Paolo Corti]

Hi all

I am new to this list, as I am new to the QGIS development workflows,
but I am generally very interested in best practices for keeping
documentation.

Together with Paolo Cavallini, we have been considering which best
practices could be considered for keeping the QGIS documentation.
You may probably already be aware that a wide spread approach for
keeping software documentation nowadays is to keep the documentation
in reStructuredText format, using Sphinx for rendering it and managing
multiple languages versions (via the Pootle web application, if we
expect a large numbers of users is willing to contribute).

Documentation tied to specific release can just live in the source
tree, tagged together with sofware release and eventually rendered on
software web site pulling it from the source.
This is the same approach that has been used for other popular OSGeo
projects like MapServer and GeoServer.
I have tried to summarize the approach in this blog post [0]

I would like to hear your opinion about eventually migrating the whole
QGIS project docs to Sphinx. I am ready to contribute to this, if this
idea is well receipt from all of you :)

kind regards
P

[0] http://paolocorti.net/2012/01/05/managing_documentation_translations_with_open_source_tools/

-- 
Paolo Corti
Geospatial software developer
web: http://www.paolocorti.net
twitter: @capooti
skype: capooti