From beadd1d100b4bc550166c40e02615086aa3395a7 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sun, 9 Jun 2019 06:30:01 -0400 Subject: [PATCH 1/7] Use rtd config file with htmldir builder --- .readthedocs.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..8c6d64c55 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,16 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +sphinx: + builder: htmldir + configuration: conf.py + +formats: all + +python: + version: 3.7 + install: + - requirements: requirements.txt \ No newline at end of file From 33849fa216e0d6579d084f0f076b56ee22a1a5ee Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 19:35:34 +0200 Subject: [PATCH 2/7] The htmldir builder option was renamed to dirhtml to use the same name as sphinx --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 8c6d64c55..08ec03b88 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,7 +5,7 @@ version: 2 sphinx: - builder: htmldir + builder: dirhtml configuration: conf.py formats: all From 58f1548448d6108ac6ef46b0a7648bf8023a760d Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 19:36:27 +0200 Subject: [PATCH 3/7] python.version is deprecated and replaced by build.tools.python --- .readthedocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 08ec03b88..edff3d7fc 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,7 +10,10 @@ sphinx: formats: all +build: + tools: + python: "3.10" + python: - version: 3.7 install: - requirements: requirements.txt \ No newline at end of file From b5fcb4be69fe3a07be54ce39beeb2011be578227 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 19:36:33 +0200 Subject: [PATCH 4/7] Add newline --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index edff3d7fc..9ffddc765 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -16,4 +16,4 @@ build: python: install: - - requirements: requirements.txt \ No newline at end of file + - requirements: requirements.txt From 534f5e55c321f301053fe33a208b75c3a3e47433 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 19:47:50 +0200 Subject: [PATCH 5/7] Add required build.os --- .readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 9ffddc765..9305dc432 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -11,6 +11,7 @@ sphinx: formats: all build: + os: ubuntu-20.04 tools: python: "3.10" From 5e33537c0ec636c40ea06edeff59973be6b739f4 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 19:57:59 +0200 Subject: [PATCH 6/7] Python 3.10 requires newer Sphinx --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index bd66e003c..5c35935ac 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -Sphinx==4.1.2 +Sphinx==4.3.2 furo<2021.11.16 sphinx_copybutton>=0.3.3 From 47e5d407a96a2c34838c7fb81433401fa9e4b31c Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Fri, 7 Jan 2022 20:01:18 +0200 Subject: [PATCH 7/7] Update Furo --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 5c35935ac..e94a039c8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ Sphinx==4.3.2 -furo<2021.11.16 +furo<2022.1.3 sphinx_copybutton>=0.3.3