Skip to content

fix: repair documentation configs and figure captions - #42

Merged
koen-vg merged 2 commits into
mainfrom
chore-recalibrate-after-simplifications
Jul 29, 2026
Merged

fix: repair documentation configs and figure captions#42
koen-vg merged 2 commits into
mainfrom
chore-recalibrate-after-simplifications

Conversation

@koen-vg

@koen-vg koen-vg commented Jul 29, 2026

Copy link
Copy Markdown
Member

Summary

This PR repairs the documentation workflow and synchronizes its prose with the current model:

  • Fix the documentation-figure configuration so it uses the default AWARE water supply and passes calibration provenance checks.
  • Update the regional water figure to report annual renewable availability and remove the obsolete growing-season/Water Footprint Network description.
  • Keep health disabled in validation and tutorial configurations so those workflows do not require manually downloaded IHME GBD inputs; update the related documentation and tutorial notebooks accordingly.
  • Refresh stale figure captions: use the 750-region default, describe the current renewable-water methodology, and refer to the numeric multi-cropping zones and their sequential interpretation.

Validation

  • pixi run -e dev sphinx-build -b dummy docs /tmp/glade-docs-dummy
  • Repository pre-commit hooks
  • Push-time Sphinx build with warnings treated as errors

@koen-vg koen-vg changed the title docs: refresh documentation figure captions fix: repair documentation configs and figure captions Jul 29, 2026
koen-vg added 2 commits July 29, 2026 14:15
…figs

The doc_figures config pinned water.data.availability to current_use, which
contradicts the gbd-anchored calibration artefacts it consumes, so the
provenance check aborted every documentation build. Drop the pin and use the
default AWARE water supply. The regional water availability figure was the
last consumer of the growing-season column that only the current_use branch
writes; it now reports annual renewable availability, which both sources
provide, and no longer credits the volumes to the Water Footprint Network.

The validation and tutorial configs enabled health, which forced a manual IHME
GBD download on anyone running them and anchored their baseline diet to GBD
intake exposure. No validation figure or tutorial notebook reads health output,
and validation.rst and tutorial.rst both already stated health was off. Turn it
off in all four, leaving doc_figures as the single config that needs the manual
download for its health cluster, burden and marginal-YLL figures.

Also drop overrides that only restated default.yaml, fix the doc_figures header
claiming a coarser resolution it never set, and sync the affected prose.
@koen-vg
koen-vg force-pushed the chore-recalibrate-after-simplifications branch from 6bb7d9b to 452da36 Compare July 29, 2026 21:16
@koen-vg
koen-vg marked this pull request as ready for review July 29, 2026 21:16
@koen-vg
koen-vg merged commit 317c8a9 into main Jul 29, 2026
4 checks passed
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.

1 participant