From 9bea864f860da57c58138f00c3c3d1ee5cb3347a Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Mon, 15 Apr 2024 15:22:03 +0100 Subject: [PATCH 1/4] Add watchfiles module The autobuild function has removed the previous dependency and added the watchfiles dependency instead. Also removed the pdf generation from the yaml since this was breaking the RTD build --- .readthedocs.yaml | 4 ++-- docs-requirements.txt | 1 + docs/conf.py | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b7824e1c29..a0a0590b70 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,8 +19,8 @@ sphinx: # If using Sphinx, optionally build your docs in additional formats such as PDF -formats: - - pdf +#formats: +# - pdf # Optionally declare the Python requirements required to build your docs python: diff --git a/docs-requirements.txt b/docs-requirements.txt index 4aa15e4c03..32ea9539a5 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -10,3 +10,4 @@ sphinx-notfound-page sphinxcontrib-mermaid sphinxcontrib-jquery sphinxext-opengraph +watchfiles diff --git a/docs/conf.py b/docs/conf.py index 1d5e29bc91..cf87ea3c7b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,6 +40,7 @@ "sphinx.ext.autosectionlabel", "sphinxcontrib.jquery", "sphinxext.opengraph", + "watchfiles", ] autosectionlabel_prefix_document = True From 2d08b57a8594454b42ef58b24829ee09a484706a Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Mon, 15 Apr 2024 15:33:18 +0100 Subject: [PATCH 2/4] Remove fail on warning --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a0a0590b70..7d605fd3d4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,7 +15,7 @@ build: sphinx: builder: dirhtml configuration: docs/conf.py - fail_on_warning: true + fail_on_warning: false # If using Sphinx, optionally build your docs in additional formats such as PDF From 3fd937bb4ac055b42b41bbbe578a0b9714e3bed1 Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Mon, 15 Apr 2024 15:48:51 +0100 Subject: [PATCH 3/4] Testing "fail on warning" --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7d605fd3d4..a0a0590b70 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,7 +15,7 @@ build: sphinx: builder: dirhtml configuration: docs/conf.py - fail_on_warning: false + fail_on_warning: true # If using Sphinx, optionally build your docs in additional formats such as PDF From c490afb003b808206109c6ebb7b260b17adaa19b Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Mon, 15 Apr 2024 15:54:57 +0100 Subject: [PATCH 4/4] Remove watchfiles from extension list It's a package, not an extension --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index cf87ea3c7b..1d5e29bc91 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,6 @@ "sphinx.ext.autosectionlabel", "sphinxcontrib.jquery", "sphinxext.opengraph", - "watchfiles", ] autosectionlabel_prefix_document = True