Merge pull request #1165 from tlestang/develop

Add readthedocs config file

.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

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

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