Re: [QGIS-Developer] QGIS Doc Travis
On Sun, Mar 15, 2020 at 4:45 PM Richard Duivenvoorde wrote: > > On 3/15/20 4:08 PM, Richard Duivenvoorde wrote: > > We will probably change master branch soon so it will get build in the > > same way... > > Done: > > https://docs.qgis.org/testing/en/docs/ > > Please have a look and fix things. > I've barely looked at old build versions, just copied build machinery > from qgisdoc2020 branch. So if something was kicked into eternity, > please resurrect if from git... Hi Richard, looks great! > > We still need to sort out how to build automaticaly: travis, github > actions, whatever. Please feel free to kick in! > I might have missed something, but if I'm not wrong Travis already build the docs during the testing process (but in a single language?). What you are talking about is continuous deployment (CD) right? You could probably do with both Travis and github workflows, you just need to make sure that the CD only happens on each commit to master. In order to be able to push the build to the deployment server you'll probably need a deployment SSH key stored as a secret on Travis (or GH workflow) that allow the Travis (or GH workflow) process to transfer the built files to the production server. -- Alessandro Pasotti w3: www.itopen.it ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
On 3/15/20 4:08 PM, Richard Duivenvoorde wrote: > We will probably change master branch soon so it will get build in the > same way... Done: https://docs.qgis.org/testing/en/docs/ Please have a look and fix things. I've barely looked at old build versions, just copied build machinery from qgisdoc2020 branch. So if something was kicked into eternity, please resurrect if from git... We still need to sort out how to build automaticaly: travis, github actions, whatever. Please feel free to kick in! Regards, Richard ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
On 3/15/20 3:37 PM, r.m.aguilardearch...@utwente.nl wrote: > Hey. Guys. > Just to let you know. I built the doc in Windows. Looks beautiful. > I just felt a bit confusing with the windows instructions. > Because when I cloned the repo I did not get the make.bat ( I could not clone > the qgisdoc2020 branch directly- beginner mistake?) > So, I needed to create the branch first before actually compile it. > Perhaps adding such make.bat in the master branch may help? Hi Rosa, Till now the qgis2020 branch is just an experiment to build 3.10, that is. At this moment there was just no make.bat on master yet :-) We choose to build 3.10 because all the translation machinery has to be there and working too. We will probably change master branch soon so it will get build in the same way... If others find errors/issues with instructions, please fix. Regards, Richard ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
Hey. Guys.
Just to let you know. I built the doc in Windows. Looks beautiful.
I just felt a bit confusing with the windows instructions.
Because when I cloned the repo I did not get the make.bat ( I could not clone
the qgisdoc2020 branch directly- beginner mistake?)
So, I needed to create the branch first before actually compile it.
Perhaps adding such make.bat in the master branch may help?
Nice work.
Cheers,
Rosa
-
MSc Rosa Aguilar
PhD Candidate
Faculty of Geoinformation Science and Earth Observation
University of Twente
Enschede, The Netherlands
Telephone: +31 647616029
https://www.linkedin.com/in/rosamaguilar/?locale=en_US
https://rosaguilar.github.io/
-
-Original Message-
From: QGIS-Developer On Behalf Of
Richard Duivenvoorde
Sent: 15 March 2020 09:44
To: matteo ; qgis-developer@lists.osgeo.org
Subject: Re: [QGIS-Developer] QGIS Doc Travis
On 3/15/20 8:57 AM, matteo wrote:
> That's what comes into my mind:
>
> * verify Transifex pulling/pushing
> * apache on the server to publish the docs
> * ... what else?
@Raymond thanks for organising the hackfest! Sorry for not being there... But
the 'doc-team' did some things related to documentations because there WAS a
hackfest \o/
There are 2 things I want to discuss here.
First our main goal: "KISS".
Everybody on windows or linux should be able to build at least the english docs.
Second: stick to Sphinx and it's tools as much as possible (e.g. instead of
custom scripts: use sphinx-intl to create transifex stuff).
My main 2 questions, I would like to discuss:
-1- CAN we use Travis to build the translated site (daily) (technically:
yes, I know, but...)
-2- WHICH process should be responsible for the pulling of the transifex
translations into the build process
Ad -1-
"Make doctest" will use the qgis/qgis docker container to build and run the
tests. Travis is happy with that [4]
So we could update or base a new image on it containing all language related
stuff, and use travis to build all languages. Current 3.4 builds pull fresh
from transifex (making a language build lasts for half an hour now
sometimes...) If we push the po files into github, it will only be 10 minutes.
But my main question is: can/should we 'misuse' travis to build all those
(currently 18) languages daily.
Ad -2-
Several options:
- during our main build, the build pulls (tx pull) from transifex. Is what we
do now: Transifex is main repo for translations. IF an individual wants to
build a translated doc, she/he needs to pull the translations from transifex
itself (which is a disadvantage, as pulling translations from tx is SLOW...)
- we run a daily script which pulls the translations from tx and commits those
po files (for ALL languages to be build) in git-repo.
Main advantage: we keep being boss over the po files ourselves, AND everybody
can build translated docs, because the po files are (well 1 day old...) in git
- use the Transifex Github integration (I played with it one year ago, and then
it could not handle our long resource handles at that time...)
I think I prefer the second or third option, will push nl, it and fr
translations into git later today (by just pulling the 3.4 translations from
build server), so everybody can try to build translated sites too.
Als together with maybe building it on travis, it is probably the best way..
Want to see current status?
- vanilla Sphinx local ( EVERYBODY can try to build branch qgisdoc2020 NOW on
windows and linux, see README [0] )
- vanilla Sphinx remote ('make site' works if you can like me rsync to
qgis2 [1]) (NOTE: a lot has to be done there)
- everybody should now be able to 'just edit' on github [2]
- 'make doctest' (== building in te qgis/qgis docker image) is also working,
see travis [4] qgisdoc2020 branch there
Sorry for being rather long, and while writing maybe answering my own questions
:-)
But I really really hope we can keep stuff as simple as possible and encourage
everybody to JOIN. Please contact us via documentation list
About PDF's: maybe later... but I'm OK without those...
So if you want them: join us
Regards,
Richard Duivenvoorde
[0] https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020
[1] https://docs.qgis.org/3.10/
[3]
https://github.com/qgis/QGIS-Documentation/blob/qgisdoc2020/docs/user_manual/introduction/getting_started.rst
[4] https://travis-ci.org/github/qgis/QGIS-Documentation
[5] https://docs.transifex.com/transifex-github-integrations/github-tx-ui
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
___
QGIS-Developer mailing list
QGIS-Develop
Re: [QGIS-Developer] QGIS Doc Travis
Hi Richard,
Instead of travis, maybe we can try to use github actions instead?
Alex
On Sun, Mar 15, 2020 at 8:43 AM Richard Duivenvoorde
wrote:
> On 3/15/20 8:57 AM, matteo wrote:
> > That's what comes into my mind:
> >
> > * verify Transifex pulling/pushing
> > * apache on the server to publish the docs
> > * ... what else?
>
> @Raymond thanks for organising the hackfest! Sorry for not being
> there... But the 'doc-team' did some things related to documentations
> because there WAS a hackfest \o/
>
> There are 2 things I want to discuss here.
>
> First our main goal: "KISS".
> Everybody on windows or linux should be able to build at least the
> english docs.
>
> Second: stick to Sphinx and it's tools as much as possible (e.g. instead
> of custom scripts: use sphinx-intl to create transifex stuff).
>
> My main 2 questions, I would like to discuss:
>
> -1- CAN we use Travis to build the translated site (daily) (technically:
> yes, I know, but...)
>
> -2- WHICH process should be responsible for the pulling of the transifex
> translations into the build process
>
> Ad -1-
> "Make doctest" will use the qgis/qgis docker container to build and run
> the tests. Travis is happy with that [4]
>
> So we could update or base a new image on it containing all language
> related stuff, and use travis to build all languages. Current 3.4 builds
> pull fresh from transifex (making a language build lasts for half an
> hour now sometimes...) If we push the po files into github, it will only
> be 10 minutes.
> But my main question is: can/should we 'misuse' travis to build all
> those (currently 18) languages daily.
>
> Ad -2-
> Several options:
> - during our main build, the build pulls (tx pull) from transifex. Is
> what we do now: Transifex is main repo for translations. IF an
> individual wants to build a translated doc, she/he needs to pull the
> translations from transifex itself (which is a disadvantage, as pulling
> translations from tx is SLOW...)
> - we run a daily script which pulls the translations from tx and commits
> those po files (for ALL languages to be build) in git-repo.
> Main advantage: we keep being boss over the po files ourselves, AND
> everybody can build translated docs, because the po files are (well 1
> day old...) in git
> - use the Transifex Github integration (I played with it one year ago,
> and then it could not handle our long resource handles at that time...)
>
> I think I prefer the second or third option, will push nl, it and fr
> translations into git later today (by just pulling the 3.4 translations
> from build server), so everybody can try to build translated sites too.
> Als together with maybe building it on travis, it is probably the best
> way..
>
> Want to see current status?
>
> - vanilla Sphinx local ( EVERYBODY can try to build branch qgisdoc2020
> NOW on windows and linux, see README [0] )
>
> - vanilla Sphinx remote ('make site' works if you can like me rsync to
> qgis2 [1]) (NOTE: a lot has to be done there)
>
> - everybody should now be able to 'just edit' on github [2]
>
> - 'make doctest' (== building in te qgis/qgis docker image) is also
> working, see travis [4] qgisdoc2020 branch there
>
>
> Sorry for being rather long, and while writing maybe answering my own
> questions :-)
>
> But I really really hope we can keep stuff as simple as possible and
> encourage everybody to JOIN. Please contact us via documentation list
>
> About PDF's: maybe later... but I'm OK without those...
> So if you want them: join us
>
> Regards,
>
> Richard Duivenvoorde
>
>
> [0] https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020
> [1] https://docs.qgis.org/3.10/
> [3]
>
> https://github.com/qgis/QGIS-Documentation/blob/qgisdoc2020/docs/user_manual/introduction/getting_started.rst
> [4] https://travis-ci.org/github/qgis/QGIS-Documentation
> [5] https://docs.transifex.com/transifex-github-integrations/github-tx-ui
> ___
> QGIS-Developer mailing list
> QGIS-Developer@lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
On 3/15/20 8:57 AM, matteo wrote:
> That's what comes into my mind:
>
> * verify Transifex pulling/pushing
> * apache on the server to publish the docs
> * ... what else?
@Raymond thanks for organising the hackfest! Sorry for not being
there... But the 'doc-team' did some things related to documentations
because there WAS a hackfest \o/
There are 2 things I want to discuss here.
First our main goal: "KISS".
Everybody on windows or linux should be able to build at least the
english docs.
Second: stick to Sphinx and it's tools as much as possible (e.g. instead
of custom scripts: use sphinx-intl to create transifex stuff).
My main 2 questions, I would like to discuss:
-1- CAN we use Travis to build the translated site (daily) (technically:
yes, I know, but...)
-2- WHICH process should be responsible for the pulling of the transifex
translations into the build process
Ad -1-
"Make doctest" will use the qgis/qgis docker container to build and run
the tests. Travis is happy with that [4]
So we could update or base a new image on it containing all language
related stuff, and use travis to build all languages. Current 3.4 builds
pull fresh from transifex (making a language build lasts for half an
hour now sometimes...) If we push the po files into github, it will only
be 10 minutes.
But my main question is: can/should we 'misuse' travis to build all
those (currently 18) languages daily.
Ad -2-
Several options:
- during our main build, the build pulls (tx pull) from transifex. Is
what we do now: Transifex is main repo for translations. IF an
individual wants to build a translated doc, she/he needs to pull the
translations from transifex itself (which is a disadvantage, as pulling
translations from tx is SLOW...)
- we run a daily script which pulls the translations from tx and commits
those po files (for ALL languages to be build) in git-repo.
Main advantage: we keep being boss over the po files ourselves, AND
everybody can build translated docs, because the po files are (well 1
day old...) in git
- use the Transifex Github integration (I played with it one year ago,
and then it could not handle our long resource handles at that time...)
I think I prefer the second or third option, will push nl, it and fr
translations into git later today (by just pulling the 3.4 translations
from build server), so everybody can try to build translated sites too.
Als together with maybe building it on travis, it is probably the best
way..
Want to see current status?
- vanilla Sphinx local ( EVERYBODY can try to build branch qgisdoc2020
NOW on windows and linux, see README [0] )
- vanilla Sphinx remote ('make site' works if you can like me rsync to
qgis2 [1]) (NOTE: a lot has to be done there)
- everybody should now be able to 'just edit' on github [2]
- 'make doctest' (== building in te qgis/qgis docker image) is also
working, see travis [4] qgisdoc2020 branch there
Sorry for being rather long, and while writing maybe answering my own
questions :-)
But I really really hope we can keep stuff as simple as possible and
encourage everybody to JOIN. Please contact us via documentation list
About PDF's: maybe later... but I'm OK without those...
So if you want them: join us
Regards,
Richard Duivenvoorde
[0] https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020
[1] https://docs.qgis.org/3.10/
[3]
https://github.com/qgis/QGIS-Documentation/blob/qgisdoc2020/docs/user_manual/introduction/getting_started.rst
[4] https://travis-ci.org/github/qgis/QGIS-Documentation
[5] https://docs.transifex.com/transifex-github-integrations/github-tx-ui
___
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
Thanks for all the hints. Apparently we were missing something silly (that's the effect of a remote HackFest :D ) anyway, travis is now happy with both documentation and pyqgis test (thanks Richard for the fix). I really think this is the perfect moment to move on to the rtd theme and release the 3.10 documentation. So what are the blockers? can we write a todo list and squash all the problems? That's what comes into my mind: * verify Transifex pulling/pushing * apache on the server to publish the docs * ... what else? Cheers Matteo ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
Hi, you don't need a Travis sorcerer, the commands do not even run on a local installation. Try this patch: https://termbin.com/mmb7 On Sat, Mar 14, 2020 at 5:59 PM matteo wrote: > > Hi all, > > we (Richard, me, Harrissou) are trying to build the QGI doc (3.19) with > the rtd theme (thank to Harrissou and Richard jobs). > > All the progress are on branch qgisdoc2020 in the official > QGIS-Documentation repository: > > https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020 > > But we are stuck with Travis: > > https://travis-ci.org/github/qgis/QGIS-Documentation/builds/662445827?utm_source=github_status_medium=notification > > can some Travis guru have a look and help us fix it? > > Cheers and thanks > > Matteo > > ___ > QGIS-Developer mailing list > QGIS-Developer@lists.osgeo.org > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer -- Alessandro Pasotti w3: www.itopen.it ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
> > > > > > -- Forwarded message -- > From: Denis Rouzaud > To: matteo > Cc: qgis-developer , qgis-community < > qgis-community-t...@lists.osgeo.org>, Richard Duivenvoorde < > rich...@duif.net> > Bcc: > Date: Sat, 14 Mar 2020 18:06:31 +0100 > Subject: Re: [QGIS-Developer] QGIS Doc Travis > > > Le sam. 14 mars 2020 à 17:59, matteo a écrit : > >> Hi all, >> >> we (Richard, me, Harrissou) are trying to build the QGI doc (3.19) with >> the rtd theme (thank to Harrissou and Richard jobs). >> >> All the progress are on branch qgisdoc2020 in the official >> QGIS-Documentation repository: >> >> https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020 >> >> But we are stuck with Travis: >> >> >> https://travis-ci.org/github/qgis/QGIS-Documentation/builds/662445827?utm_source=github_status_medium=notification >> >> can some Travis guru have a look and help us fix it? > > Apparently you're not looking for a Travis guru, but a Sphinx guru: sphinx-build: error: the following arguments are required: outputdir, filenames https://travis-ci.org/github/qgis/QGIS-Documentation/builds/662445827#L750 I would recommend you to run the same on your machine, run interactively the Docker container so you can try what's going wrong with the sphinx-build command. > > ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Re: [QGIS-Developer] QGIS Doc Travis
sorry, 3.10 :) ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
[QGIS-Developer] QGIS Doc Travis
Hi all, we (Richard, me, Harrissou) are trying to build the QGI doc (3.19) with the rtd theme (thank to Harrissou and Richard jobs). All the progress are on branch qgisdoc2020 in the official QGIS-Documentation repository: https://github.com/qgis/QGIS-Documentation/tree/qgisdoc2020 But we are stuck with Travis: https://travis-ci.org/github/qgis/QGIS-Documentation/builds/662445827?utm_source=github_status_medium=notification can some Travis guru have a look and help us fix it? Cheers and thanks Matteo ___ QGIS-Developer mailing list QGIS-Developer@lists.osgeo.org List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
