[Qgis-community-team] new site with sphinx documentation

Paolo Corti pcorti at gmail.com
Tue May 29 08:13:06 PDT 2012


Hi
I have finally committed the new project structure.

It is possible to read the HTML version of the documentation for many
languages here:

English: http://documentation.qgis.org/
German: http://documentation.qgis.org/html/user_guide/de/
French: http://documentation.qgis.org/html/user_guide/fr/
Italian: http://documentation.qgis.org/html/user_guide/it/

BTW, What other language should I add?

It is possible to read the HTML English version of the documentation
here: http://readthedocs.org/docs/qgis/en/latest/

In the qgis.org site the documentation is scheduled to be built every
30 minutes. In the readthedocs.org site it is going to be built every
time something is committed at this repository.

For managing the automatic build for each commit for the RTD, I would
need to add a webhook [1]. In order to do this, I need to be an
administrator of the github project [2]: can anyone promote me?
Or you can add yourself the webhook, just let me know.

Thanks
p

[1] http://read-the-docs.readthedocs.org/en/latest/webhooks.html
[2] https://github.com/qgis/QGIS-Documentation

On Thu, May 24, 2012 at 5:02 PM, Paolo Corti <pcorti at gmail.com> wrote:
> Hi
>
> I have added a new site in the qgis.org server with the QGIS Sphinx
> documentation build:
>
> http://docs.qgis.org
>
> also aliased as:
>
> http://documentation.qgis.org/
>
> the default documentation site is for the English language, other
> languages can be reached like this (but they are still in English, as
> translations are still not in the git repository):
>
> German: http://documentation.qgis.org/html/user_guide/de/
> Italian: http://documentation.qgis.org/html/user_guide/it/
> French: http://documentation.qgis.org/html/user_guide/fr/
>
> other languages may be added following the procedures described in the
> readme file:
> https://github.com/qgis/QGIS-Documentation/blob/master/readme.rst
>
> and adding the language code in the TRANSLATION variable in Makefile.
>
> The documentation is rebuilt every 30 minutes by a job in crontab.
> Another possible option could be to add a github service hook [1] or
> using the ReadTheDocs service [2].
> Unluckily with the latter (RTD) I was not able to add the actual
> QGIS-Documentation: build fails for some unidentified reason [3]
>
> According to Eric Holscher the build fails for this reason:
>
> "Looks like your checkout was in a bad state (complaining about SHA
> mismatch? Did you force push or something?) I killed the repo and
> rebuilt it, and it seems to be happy again."
>
> Unluckily after some time it fails building again (Tim, any suggestion?)
>
> thanks
> p
>
> [1] http://help.github.com/post-receive-hooks/
> [2] http://readthedocs.org/
> [3] http://readthedocs.org/builds/qgis/
>
> --
> Paolo Corti
> Geospatial software developer
> web: http://www.paolocorti.net
> twitter: @capooti
> skype: capooti



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


More information about the Qgis-community-team mailing list