Add Nix package for PyQGIS API Documentation builder

[imincik]

No description provided.

[nyalldawson]

Can you help me understand what the use case is here? Currently all the documentation is built using github workflows, so there's really no need for this to be packaged for use elsewhere.

[timlinux]

Hi @nyalldawson

We are in the process of deploying new infrastructure with NixOS used for provisioning all the servers (including API docs and general documentation). Having this patch applied is important to us because the documentation needs to be built as a package and then deployed in order to be consistent with the methodology we are using for server deployments. All the packages will be discrete, repeatable deployments stored in cachix which is a cache platform for Nix packages.

There may be more nix related patches coming, would be grateful if we can incorporate this work. If you want more details we would be happy to hop into a call with you to explain a bit better the process we are following. @imincik is a seasoned and well respected Nix contributor, leading the effort to make geospatial tools available on Nix (including packaging QGIS on Nix) and has been contracted by the PSC (as well as contributing his own time as a volunteer) to help with our next gen infrastructure roll out that @Xpirix and I have been working on.

Regards

Tim

[nyalldawson]

@timlinux
Does that mean the plan is to remove the publishing workflows from this repository too? How often will the new process run after a commit is merged here? Will that just be on a fixed frequency regardless of when changes are made here?

In regards to this PR -- is there any way to move these files into a subfolder? I really dislike having packaging related files cluttering up the root folder of a repository.

[imincik]

In regards to this PR -- is there any way to move these files into a subfolder? I really dislike having packaging related files cluttering up the root folder of a repository.

package.nix file was moved to nix directory.

[imincik]

For the record, Nix packaging in QGIS repos was discussed during video call with @nyalldawson , @timlinux , @Xpirix and @imincik .

[imincik]

Documentation build is failing on following error after rebase on to the latest master of pyqgis-api-docs-builder

       > qt.qpa.plugin: Could not find the Qt platform plugin "xcb" in ""
       > This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
       >
       > /nix/store/plgd01gl1wvxyaxw2iafcr739s5icrsf-stdenv-linux/setup: line 1772:    53 Aborted                 (core dumped) python3 ./scripts/make_api_rst.py --version 3.44

This didn't happen before. Any ideas ?

[imincik]

Fails on

from qgis.core import QgsApplication
qgs = QgsApplication([], False)

The same command runs without problem in QGIS interactive Python console.

[imincik]

With

  env.QT_PLUGIN_PATH="${libsForQt5.qt5.qtbase}/${libsForQt5.qt5.qtbase.qtPluginPrefix}";
  env.QT_QPA_PLATFORM_PLUGIN_PATH="${libsForQt5.qt5.qtbase}/${libsForQt5.qt5.qtbase.qtPluginPrefix}/platforms";

build fails on

       > qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "/nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms" even though it was found.
       > This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
       >
       > Available platform plugins are: eglfs (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), linuxfb (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), minimal (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), minimalegl (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), offscreen (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), vnc (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), xcb (from /nix/store/4k4s06lid9njbxsyp4awphxgraz7w04g-qtbase-5.15.16-bin/lib/qt-5.15.16/plugins/platforms), eglfs, linuxfb, minimal, minimalegl, offscreen, vnc, xcb.
       >

[imincik]

Probably related to this change 2ca3643

[imincik]

Issues where fixed in a1599f1 . This change needs cleanup and should be squashed.

[imincik]

@nyalldawson , @timlinux PR is good to be merged now.

[3nids]

@imincik what's the status here? shall we merge this?

[3nids]

closing, feel free to reopen.

[imincik]

@3nids , yes we definitely need to merge this PR. Sorry for late reply. Would you please re-open ? Thanks.