Mula environment docs are broken due to Pydantic v2 upgrade #1815
Labels
bug
Something isn't working
dependencies
Pull requests that update a dependency file
documentation
Improvements or additions to documentation
mula
Issues related to the scheduler
regression
Something is broken that explicitly worked before
The online docs are missing Mula's environment settings:
See the CI output at the
Compile static HTML
step (e.g. https://github.com/minvws/nl-kat-coordination/actions/runs/6260541583/job/16998773587).settings-doc==3.0.0
has support for Pydantic v2 which is great. It also includes an updatedmarkdown.jinja
file so we should be good for the future.Unfortunately for us right now, this means that we are in a situation where some of our modules support Pydantic v2, and some do not.
settings-doc==2.0.0
must be used for Pydantic v1 installs (no backwards compatibility).We essentially have three options here:
settings-doc
compilation pipelines in GitHub Actions and the Makefile, one for Pydantic v1 and one for Pydantic v2. They will have to use two separate jinja templates, but that should be doable. The main challenge here is making sure that a part of the pipeline installs and uses the older Pydantic version, and one part of the pipeline installs and uses Pydantic v2.Thoughts and opinions are welcome.
The text was updated successfully, but these errors were encountered: