[Qgis-community-team] Antw.: update disclaimer in sources

[Otto Dassau]

Hi Richard, 

This is a good solution. I will have a look tomorrow and then we integrate it for all rst files. 

Thanks a lot
Otto

----- Reply message -----
Von: "Richard Duivenvoorde" <rdmailings at duif.net>
An: "qgis-community-team at lists.osgeo.org" <qgis-community-team at lists.osgeo.org>
Betreff: [Qgis-community-team] update disclaimer in sources
Datum: Di., Okt. 16, 2012 22:51


Hi Otto,

I've been searching for an easy way to put a 'his section is not updated yet' disclaimer in every section of the html pages.

For doing this I added a rst_prolog in conf.py like this:

rst_prolog = """
... role:: disclaimer
... |updatedisclaimer| replace:: :disclaimer:`DISCLAIMER: This section of the user guide has not yet been updated for QGIS 1.8`
"""

And (for now) in all rst files in the preamble directory, I added the following on top:

... comment out this disclaimer (by putting '.. ' in front of it) if file is uptodate with release
|updatedisclaimer|

Please have a look at the pages in the preamble (you should see a big red sign in top)

The idea is that when a rst is up to date with 1.8 we can just comment out
|updatedisclaimer|
by doing
... |updatedisclaimer|
and the disclaimer will disappear from this section for this page.

When a new release is planned, and we want a new disclaimer in master, we only have to change the updatedisclaimer-replace in conf.py and remove comment from the |updatedisclaimer| parts in those sections that really need updates.

Ok for you? Or is there a more easy/clever way to do something like this?
If OK, I will put the disclaimer in all rst files.

R

_______________________________________________
Qgis-community-team mailing list
Qgis-community-team at lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/qgis-community-team
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20121016/efdc6496/attachment.html>