Skip to content

[ENSCORESW-3082, ENSCORESW-3080] Add .readthedocs.yml config file specifying stable build image

Marek Szuba requested to merge github/fork/ens-bwalts/version/2.5 into version/2.5

Created by: ens-bwalts

Use case

From time to time changes the build container (and underlying Ubuntu version) that it uses to build documentation. When the Ubuntu version of the container changes, it breaks our documentation build, because our build relies on several external dependencies. These dependencies are satisfied by downloading and extracting specific .deb packages (specified in docs/ which are specific to a specific Ubuntu version. By specifying a specific build container version, we can minimize the frequency of build-breaking upgrades, and easily update the specific .deb packages in if needed.


Add .readthedocs.yml configuration file that specifies that rtd use the "stable" build container image.

Possible Drawbacks

This file will need to be maintained. In case of conflicts between .readthedocs.yml and settings in the settings interface of the admin site, it appears that the values set via the website override settings in the config file, which could cause confusion.


Have you added/modified unit tests to test the changes?

Tested using a separate build project on

If so, do the tests pass/fail?

Build successful, including autogenerated diagrams and doxygen

Have you run the entire test suite and no regression was detected? Yes

Merge request reports