diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000000..a1964b5efb --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,18 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: false + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.8 + install: + - requirements: docs/requirements.txt diff --git a/.requirements-docs.txt b/.requirements-docs.txt deleted file mode 100644 index 6f64da0258..0000000000 --- a/.requirements-docs.txt +++ /dev/null @@ -1,10 +0,0 @@ -# Requirements for readthedocs.io -numpy>=1.14 -scipy>=1.3 -pandas>=0.23 -anytree>=2.4.3 -autograd>=1.2 -scikit-fem>=0.2.0 -casadi>=3.5.0 -guzzle-sphinx-theme -sphinx>=1.5 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..1fa06acecb --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,19 @@ +# Requirements for readthedocs.io +numpy >= 1.16 +scipy >= 1.3 +pandas >= 0.24 +anytree >= 2.4.3 +autograd >= 1.2 +scikit-fem >= 0.2.0 +casadi >= 3.5.0 +jax>=0.1.68 +jaxlib>=0.1.47 +jupyter # For example notebooks +# Note: Matplotlib is loaded for debug plots but to ensure pybamm runs +# on systems without an attached display it should never be imported +# outside of plot() methods. +# Should not be imported +matplotlib >= 2.0 +# +guzzle-sphinx-theme +sphinx>=1.5 diff --git a/requirements.txt b/requirements.txt index 3c1ab407a0..d5d382cec9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,6 +5,8 @@ anytree >= 2.4.3 autograd >= 1.2 scikit-fem >= 0.2.0 casadi >= 3.5.0 +jax>=0.1.68 +jaxlib>=0.1.47 jupyter # For example notebooks # Note: Matplotlib is loaded for debug plots but to ensure pybamm runs # on systems without an attached display it should never be imported