As a recommendation against this from happening again, ReadTheDocs.org recommends adding a .readthedocs.yaml file to the root directory. This configuration file specifies the paths to the requirements.txt and conf.py that are used by ReadTheDocs to build the documentation. It also specifies the versions of python and other tools that are used internally.
Here we add a .readthedocs.yaml that is consistent with other repositories in the geoschem organization.
laestrada
commented
1 year ago
Problem
Recently, a software update on the ReadTheDocs side resulted in a side-effect that caused ReadTheDocs builds to fail. See https://github.com/readthedocs/readthedocs.org/issues/10290 for details.
Solution
As a recommendation against this from happening again, ReadTheDocs.org recommends adding a
.readthedocs.yamlfile to the root directory. This configuration file specifies the paths to therequirements.txtandconf.pythat are used by ReadTheDocs to build the documentation. It also specifies the versions of python and other tools that are used internally.Here we add a
.readthedocs.yamlthat is consistent with other repositories in the geoschem organization.