From 094c1263d8e1962c3bc5b76c689e59b2e7ae9222 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 15:58:33 +0100 Subject: [PATCH 01/11] try fix --- docs/requirements.txt | 1 - requirements.txt | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 38519655..6ebc00dd 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,3 @@ mkdocstrings-python-legacy mkdocs-material mkdocs-jupyter -protobuf==3.20.* diff --git a/requirements.txt b/requirements.txt index 353da068..6c084664 100644 --- a/requirements.txt +++ b/requirements.txt @@ -14,4 +14,4 @@ textwrapper dask[complete] ray redis -protobuf==3.20.* +protobuf >= 3.8.0, < 4.0.0 From 17cfeab5ccba7d9eaf489fa2bb394b8f8a1e1719 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 16:15:54 +0100 Subject: [PATCH 02/11] this might work --- .readthedocs.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6020b808..991fa707 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,11 +11,16 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: true + +build: + jobs: + post_create_environment: + - python -m pip install --no-cache-dir .[extras] + # Optionally set the version of Python and requirements required to build your docs python: version: "3.8" install: - - requirements: requirements.txt - requirements: docs/requirements.txt - method: pip path: . From b64a16e1d0195c6395e5378176e19854590bec7b Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 16:20:30 +0100 Subject: [PATCH 03/11] meh --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 991fa707..5b9f5179 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,7 +15,7 @@ mkdocs: build: jobs: post_create_environment: - - python -m pip install --no-cache-dir .[extras] + - python -m pip install --no-cache-dir .[docs] # Optionally set the version of Python and requirements required to build your docs python: From 2de8a4d9f14bade608e775d1b36c3a4b64b3a860 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 16:22:32 +0100 Subject: [PATCH 04/11] undo --- .readthedocs.yaml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 5b9f5179..6020b808 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,16 +11,11 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: true - -build: - jobs: - post_create_environment: - - python -m pip install --no-cache-dir .[docs] - # Optionally set the version of Python and requirements required to build your docs python: version: "3.8" install: + - requirements: requirements.txt - requirements: docs/requirements.txt - method: pip path: . From b3e88d91c52cfab00418a676f2c96b8314082ce6 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 16:37:31 +0100 Subject: [PATCH 05/11] try building with conda for docs and updating protobuf in environment.yml --- .readthedocs.yaml | 13 ++----------- environment.yml | 2 +- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6020b808..d9cf6160 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,14 +11,5 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: true -# Optionally set the version of Python and requirements required to build your docs -python: - version: "3.8" - install: - - requirements: requirements.txt - - requirements: docs/requirements.txt - - method: pip - path: . - extra_requirements: - - docs - \ No newline at end of file +conda: + environment: environment.yml \ No newline at end of file diff --git a/environment.yml b/environment.yml index d635c9ad..08def721 100644 --- a/environment.yml +++ b/environment.yml @@ -17,7 +17,7 @@ dependencies: - sympy - redis - pyyaml - - protobuf + - protobuf >=3.8.0,<4.0.0 - imageio - grpcio - future From 515f601f51addd6d4df2ce9ac92c032019f41054 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 16:52:08 +0100 Subject: [PATCH 06/11] add mkdocs requirements back in --- .readthedocs.yaml | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d9cf6160..7e019fe8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,9 +7,18 @@ version: 2 formats: all +conda: + environment: environment.yml + +# Add the docs requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - docs + mkdocs: configuration: mkdocs.yml - fail_on_warning: true - -conda: - environment: environment.yml \ No newline at end of file + fail_on_warning: true \ No newline at end of file From c17881d6f194bef8ee12b399fba7ef7886845fba Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Thu, 9 Jun 2022 17:01:09 +0100 Subject: [PATCH 07/11] try putting docs deps in yml --- .readthedocs.yaml | 11 +---------- environment.yml | 5 ++++- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7e019fe8..577c9350 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,16 +9,7 @@ formats: all conda: environment: environment.yml - -# Add the docs requirements required to build your docs -python: - install: - - requirements: docs/requirements.txt - - method: pip - path: . - extra_requirements: - - docs mkdocs: configuration: mkdocs.yml - fail_on_warning: true \ No newline at end of file + fail_on_warning: false \ No newline at end of file diff --git a/environment.yml b/environment.yml index 08def721..86c7aed1 100644 --- a/environment.yml +++ b/environment.yml @@ -33,4 +33,7 @@ dependencies: - pybamm - lcapy - scikit-spatial - - ray \ No newline at end of file + - ray + - mkdocstrings-python-legacy + - mkdocs-material + - mkdocs-jupyter \ No newline at end of file From b52ff1cc530ca5e71f88728ee4e7551824f8df71 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Fri, 10 Jun 2022 09:46:17 +0100 Subject: [PATCH 08/11] try adding post_install job to install extra docs deps --- .readthedocs.yaml | 7 ++++++- environment.yml | 3 --- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 577c9350..1d2058c0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,4 +12,9 @@ conda: mkdocs: configuration: mkdocs.yml - fail_on_warning: false \ No newline at end of file + fail_on_warning: false + +jobs: + post_install: + # install docs dependencies + - python -m pip install docs/requirements.txt \ No newline at end of file diff --git a/environment.yml b/environment.yml index 86c7aed1..7cfc8a7f 100644 --- a/environment.yml +++ b/environment.yml @@ -34,6 +34,3 @@ dependencies: - lcapy - scikit-spatial - ray - - mkdocstrings-python-legacy - - mkdocs-material - - mkdocs-jupyter \ No newline at end of file From 659a38bbc9d4935fda7d4f308b207d864cce1472 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Fri, 10 Jun 2022 10:06:10 +0100 Subject: [PATCH 09/11] try this --- .readthedocs.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1d2058c0..2ef752c0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,7 +14,8 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: false -jobs: - post_install: - # install docs dependencies - - python -m pip install docs/requirements.txt \ No newline at end of file +build: + jobs: + post_install: + # install docs dependencies + - python -m pip install docs/requirements.txt \ No newline at end of file From e103534f5ed7a4093c991f0840c05a9e0db792a5 Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Fri, 10 Jun 2022 10:12:38 +0100 Subject: [PATCH 10/11] Try making new yaml file --- .readthedocs.yaml | 7 +------ environment.docs.yml | 6 ++++++ 2 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 environment.docs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2ef752c0..6ecd889a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,13 +9,8 @@ formats: all conda: environment: environment.yml + environment: environment.docs.yml mkdocs: configuration: mkdocs.yml fail_on_warning: false - -build: - jobs: - post_install: - # install docs dependencies - - python -m pip install docs/requirements.txt \ No newline at end of file diff --git a/environment.docs.yml b/environment.docs.yml new file mode 100644 index 00000000..7689be7c --- /dev/null +++ b/environment.docs.yml @@ -0,0 +1,6 @@ +name: liionpack +dependencies: + - pip: + - mkdocstrings-python-legacy + - mkdocs-material + - mkdocs-jupyter From 5846890a382af2c1d1326574909c86c71694b74b Mon Sep 17 00:00:00 2001 From: Tom Tranter Date: Fri, 10 Jun 2022 10:15:53 +0100 Subject: [PATCH 11/11] Go back to just putting docs in normal yaml --- .readthedocs.yaml | 1 - environment.docs.yml | 6 ------ environment.yml | 3 +++ 3 files changed, 3 insertions(+), 7 deletions(-) delete mode 100644 environment.docs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6ecd889a..d3eb2f78 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,6 @@ formats: all conda: environment: environment.yml - environment: environment.docs.yml mkdocs: configuration: mkdocs.yml diff --git a/environment.docs.yml b/environment.docs.yml deleted file mode 100644 index 7689be7c..00000000 --- a/environment.docs.yml +++ /dev/null @@ -1,6 +0,0 @@ -name: liionpack -dependencies: - - pip: - - mkdocstrings-python-legacy - - mkdocs-material - - mkdocs-jupyter diff --git a/environment.yml b/environment.yml index 7cfc8a7f..86c7aed1 100644 --- a/environment.yml +++ b/environment.yml @@ -34,3 +34,6 @@ dependencies: - lcapy - scikit-spatial - ray + - mkdocstrings-python-legacy + - mkdocs-material + - mkdocs-jupyter \ No newline at end of file