capooti / qgis-sphinx-doc

QGIS documentation in .rst rendered in html and pdf by Sphinx

QGIS Documentation

Introduction

View Online (html) (only in English, ReadTheDocs does not support Internationalization at this time)

This repository stores official QGIS documentation.

http://qgis.org

Paolo Corti April, 2012

Setup

1. create a virtualenv and activate it (I generally mantain all the virtualenvs in a ~/virtualenv but you may create it in your preferred location):

   $ virtualenv --no-site-packages sphinx-env
   $ source sphinx-env/bin/activate
   

2. install sphinx in the virtualenv:

   (sphinx-env)$ pip install sphinx
   

3. clone the github project:

   (sphinx-env)$ git clone https://[email protected]/capooti/qgis-sphinx-doc.git
   

4. build the sphinx project with the build.sh script:

   (sphinx-env)./build.sh
   

Some quick note on internationalization

Project administrators must have generated .pot files:

$ sphinx-build -b gettext source/ source/translated/pot/

To add a new language

1. copy the source/translated/pot directory to source/transated/your-language-code directory, where your-language-code is the ISO language code with 2 digits

2. rename the files .pot to .po and edit them

3. compile the .po files you have edited:

   $ msgfmt introduction.po -o translated/it/LC_MESSAGES/introduction.mo
   

4. to build/rebuild all the template files:

   $ sphinx-build -b gettext source/ source/translated/pot/
   

5. This will check if a .po file needs to be updated:

   $ msgmerge source/translated/it/introduction.po
   source/translated/pot/introduction.pot -U
   

6. At this point the translator can check the introduction.po file and check the paragraphs that need to be updated, marked with a #fuzzy tag

Editors

1. Check out Gtranslator
2. ...

TODO