This repository contains the code for CHEEREIO, which supports data assimilation and emissions inversions for arbitrary runs of the GEOS-Chem chemical transport model via an ensemble approach (i.e. without the model adjoint).
MIT License
10
stars
4
forks
source link
Add .readthedocs.yaml and docs/requirements.txt to futureproof against updates at the RTD site #6
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 what we have done with the various GEOS-Chem repositories. We also add a docs/requirements.txt to request specific versions of sphinx and sphinx-rtd-theme that have been proven to work together. These updates should "futureproof" us against any side-effects caused by updates to Python packages at the RTD site.
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 and https://github.com/readthedocs/readthedocs.org/issues/10317 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 what we have done with the various GEOS-Chem repositories. We also add adocs/requirements.txtto request specific versions ofsphinxandsphinx-rtd-themethat have been proven to work together. These updates should "futureproof" us against any side-effects caused by updates to Python packages at the RTD site.