From 553bf7d528754379fbdfbf6810372b3dd193327d Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 3 Aug 2023 19:07:19 +0530 Subject: [PATCH 1/4] Move `.readthedocs.yaml` to `docs/.readthedocs.yaml` --- .readthedocs.yaml => docs/.readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .readthedocs.yaml => docs/.readthedocs.yaml (100%) diff --git a/.readthedocs.yaml b/docs/.readthedocs.yaml similarity index 100% rename from .readthedocs.yaml rename to docs/.readthedocs.yaml From 164a1b1cd8e9e02df652811a96c63d417a8319c8 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 3 Aug 2023 19:07:33 +0530 Subject: [PATCH 2/4] Install extra requirements (`docs` and `all`) --- docs/.readthedocs.yaml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml index 41e4653566..d97966ee38 100644 --- a/docs/.readthedocs.yaml +++ b/docs/.readthedocs.yaml @@ -1,4 +1,4 @@ -# .readthedocs.yml +# .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details @@ -34,7 +34,9 @@ build: # Optionally declare the Python requirements required to build your docs python: - install: - - requirements: docs/requirements.txt - - method: pip - path: . + install: + - method: pip + path: . + extra_requirements: + - docs + - all From 1032ac1d255b0af96d2ba3d32fc81b42d14e7507 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 3 Aug 2023 19:15:09 +0530 Subject: [PATCH 3/4] Deprecate `docs/requirements.txt` --- docs/requirements.txt | 36 ------------------------------------ 1 file changed, 36 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 08077d2f88..0000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,36 +0,0 @@ -# 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.6.0 -imageio>=2.9.0 -jupyter # For example notebooks -pybtex -sympy >= 1.8 -xarray -tqdm -# 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 -# -sphinx>6.0 -sphinx_rtd_theme>=0.5 -pydata-sphinx-theme -sphinx_design -sphinx-copybutton -myst-parser -sphinx-inline-tabs -sphinxcontrib-bibtex -sphinx-last-updated-by-git -nbsphinx -ipython -ipykernel -ipywidgets -sphinx-gallery -sphinx-hoverxref -sphinx-docsearch From 7143157ec07ec0924984e24e2a667e55d473a745 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Thu, 3 Aug 2023 19:16:17 +0530 Subject: [PATCH 4/4] Keep `.readthedocs.yaml` in root directory This reverts commit 3adf098e2ecd099f455712edd9277b0016313a66. --- docs/.readthedocs.yaml => .readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/.readthedocs.yaml => .readthedocs.yaml (100%) diff --git a/docs/.readthedocs.yaml b/.readthedocs.yaml similarity index 100% rename from docs/.readthedocs.yaml rename to .readthedocs.yaml