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

[Paolo Corti]

Ok, I have finally managed to make it running in Readthedocs as well
(just for English language) here [1].

In order to make it work I had to:
* remove the linfiniti-sphinx-theme as a submodule and add it as it is
in the git project
* refactor the sphinx project to be just one project: now there is a
master index.rst file in the root of the project (RTD wants just a
conf.py file)
* remove the 'rst2pdf.pdfbuilder' extensions from conf.py, as it seems
that RTD is also impacted from what I suggested in a today previous
email

as this changes will impact quiet much the actual project layout, I
have forked the repository: I will soon update the original repository
to this new structure, so please let me know ASAP if you think that
this is not a good idea (the main downside is to have just ONE sphinx
project in the repository).

You may give a look at the new structure at my fork, here [2].

Please note anyway that RTD does not support internationalization at
this time, so for now we could go with the site at docs.qgis.org.

thanks
p

[1] http://readthedocs.org/docs/qgis-documentation/en/latest/
[2] https://github.com/capooti/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