Skip to content

Add Nix package for PyQGIS API Documentation builder #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

imincik
Copy link

@imincik imincik commented Apr 22, 2025

No description provided.

@nyalldawson
Copy link
Contributor

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.

@imincik imincik force-pushed the nix-package branch 4 times, most recently from 4df81ef to d765424 Compare April 24, 2025 07:02
@imincik imincik force-pushed the nix-package branch 5 times, most recently from f09efdf to f9d0e1f Compare May 9, 2025 05:40
@timlinux
Copy link
Member

timlinux commented May 12, 2025

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
Copy link
Contributor

@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.

Comment on lines +211 to +213
"owner": "imincik",
"repo": "QGIS",
"rev": "43f75f91b5d16a8bd83cee030e015839cc2b76c2",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks odd to me -- why are we using a fork here? And will this always pin the "master" docs to some old commit?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants