From 9b06aad11d647dc308014e249d4ba721a8293bd4 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 25 Nov 2023 10:12:32 -0800 Subject: [PATCH 1/5] Update rtd yaml file --- .readthedocs.yaml | 25 +++++++++++++++++++++++++ readthedocs.yml | 5 ----- 2 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..e9bb045d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,25 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt + +conda: + environment: docs/environment.yml diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 9d944f16..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,5 +0,0 @@ -conda: - file: docs/environment.yml -python: - version: 3 - setup_py_install: true From f04c3997f127c1351273fb04e67061bbdd1d74ef Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 25 Nov 2023 10:27:08 -0800 Subject: [PATCH 2/5] use mamba --- .readthedocs.yaml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e9bb045d..b9d222c3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,17 +9,11 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "mambaforge-4.10" # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py -# We recommend specifying your dependencies to enable reproducible builds: -# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt - conda: environment: docs/environment.yml From 60fd34ea324c0d9f48a5c2e5d38449acb9fabe74 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 25 Nov 2023 11:41:30 -0800 Subject: [PATCH 3/5] remove comment --- .readthedocs.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b9d222c3..89f8e6ec 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,6 @@ build: tools: python: "mambaforge-4.10" -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py From 2948b37c16e84cf5dee2c7a8925c8732a8ecaba0 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 25 Nov 2023 11:53:53 -0800 Subject: [PATCH 4/5] install qtconsole --- .readthedocs.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 89f8e6ec..07769a11 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,14 @@ build: python: "mambaforge-4.10" sphinx: + builder: html + fail_on_warning: true configuration: docs/source/conf.py conda: environment: docs/environment.yml + +python: + install: + - method: pip + path: . From 9264c2ee869af88867cada75ecdbd86eb9b7fa77 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 25 Nov 2023 12:24:20 -0800 Subject: [PATCH 5/5] set lang explicitly --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 8a24ff19..1ab64004 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -91,7 +91,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: