[QGIS-Developer] Building pyqgis doc locally

[Denis Rouzaud]

Hi Matteo,

The main issue is that the website is added to a branch (gh-pages) and is
versioned.
>From time to time, I squash the commits and force push to avoid such a
large size (obviously, it's been a while since I didn't do it).
I am a bit reluctant at squashing / force pushing directly from the
workflow as any error would mean losing the pages (potentially losing the
older versions).

By fetching only the master branch you should be better.
Then, building docs shouldn't take too long. What duration are you
experiencing?

Another approach is to do a PR on the repo, you will have a built example
at https://qgis.org/pyqgis/master_PRXX (replace XX) when it's finished.

I believe it would require a bit of love to improve this workflow and drop
the gh-pages branch.

I hope this helps a bit.

Cheers,
Denis



Le mar. 13 déc. 2022 à 08:14, matteo via QGIS-Developer <
qgis-developer at lists.osgeo.org> a écrit :

> Hi devs,
>
> I've some small ideas to enhance the readthedocs theme of the pyqgis
> documentation and I want make some local test before making a pull request.
>
> I've cloned this repository (around 7GB?!):
>
> https://github.com/qgis/pyqgis
>
> and then I followed the instruction of the Readme file. It seems
> building but it is literally taking ages (./build-docs.sh
> -qgis-build-dir /home/matteo/dev/qgis-master/).
>
> Am I doing something wrong or can I use some shortcut to build it? I'm
> just playing with some css and eventually the config.py.in file.
>
> Cheers and thanks for any advice
>
> Matteo
>
> _______________________________________________
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20221213/2e779ab2/attachment.htm>