Skip to content

Check that images referenced in the docs really exist at their place#10904

Merged
DelazJ merged 9 commits into
qgis:masterfrom
DelazJ:check_image_refs
Apr 13, 2026
Merged

Check that images referenced in the docs really exist at their place#10904
DelazJ merged 9 commits into
qgis:masterfrom
DelazJ:check_image_refs

Conversation

@DelazJ

@DelazJ DelazJ commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

subset of #10856
This one is a bit... well. Quite a journey.
The script doesn't consider whether the image referenced is actually used or not (e.g. if mentioned in a commented out text or in a code-sample area. Images MUST exist. Anyway I adjusted the docs to fit in.
Still remains one point requiring a more skilled developer: handling images that are referenced with * extension, because they exist as gif (for HTML build) and png (for PDF build). I simply skip their checking for now.

@timlinux ?

@DelazJ DelazJ added the backport release_3.44 On merge create a backported pull request to 3.44 label Apr 10, 2026
@DelazJ DelazJ added the Backend label Apr 10, 2026
@timlinux

Copy link
Copy Markdown
Member

I'm struggling to review the changes here, GitHub just times out when I click the changed files tab. I'll check on my local machine...

@timlinux

Copy link
Copy Markdown
Member

LGTM - we can come back to the gif checks later.

DelazJ added 9 commits April 13, 2026 23:05
and adjust substitutions accordingly
and adjust substitutions accordingly
…ker happier

Also remove situations where file does not exist
and adjust the checker script to temporarily ignore image files
with '*' as extension value. Files can be .gif, .png or anything else
so some more cases to cover... later.
@DelazJ DelazJ force-pushed the check_image_refs branch from b194b19 to 432eac8 Compare April 13, 2026 21:09
@DelazJ DelazJ enabled auto-merge April 13, 2026 21:13
@DelazJ DelazJ merged commit 9f8be49 into qgis:master Apr 13, 2026
3 checks passed
@DelazJ DelazJ deleted the check_image_refs branch April 13, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backend backport release_3.44 On merge create a backported pull request to 3.44

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants