[QGIS-Developer] PyQGIS API docs update & more
Tim Sutton
tim at kartoza.com
Fri Jul 26 13:37:06 PDT 2024
Thanks so much for all these great updates Denis!
—
Tim Sutton
Kartoza co-founder
Open Source GIS Specialist
https://kartoza.com
> No dia 26/07/2024, às 13:27, Denis Rouzaud via QGIS-Developer <qgis-developer at lists.osgeo.org> escreveu:
>
>
> Dear all,
>
> Here is a recap of the work I've recently done for the PyQGIS API docs.
>
> After the removal of QGIS self built docker images, the way of triggering the build of API docs needed to be reworked.
> Now, API docs are built once a week for all 3 current versions (master, stable, ltr).
>
> To address the growing size of the website (>10gb, hitting limits of Github pages), now only the 3 current versions are browsable online. Older versions are downloadable as archives from the corresponding releases on PyQGIS repo (https://github.com/qgis/pyqgis/releases). Direct links are available from the main page of the docs: https://qgis.org/pyqgis/master/#versions-of-the-api
>
> Also, the repo has been renamed to emphasize the fact that it doesn't actually hold the documentation and is a "simple build tool".
>
> And to finish, a nice feature: a direct link from the PyQGIS docs to the source in cpp code to edit the docstring directly in the web browser (see in screencast in PR https://github.com/qgis/QGIS/pull/58054)
> You'd tell me, it's nice to edit the docs online, but what about sip files? We have now a sipify bot in PR (https://github.com/qgis/QGIS/pull/58057), you just need to comment with /sipify, and it will automatically update your branch (as long as you do not uncheck "Allow edits and access to secrets by maintainers" in your PR).
>
> See all this at: https://qgis.org/pyqgis/master/
>
> Kind regards,
> Denis
>
> _______________________________________________
> 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/20240726/a2257df6/attachment.htm>
More information about the QGIS-Developer
mailing list