From be2ddb3cf0f4133a3227dbafb316e2ac35913189 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 23 Mar 2024 09:23:23 -0700 Subject: [PATCH 1/3] Fix the `.readthedocs.yml` file. Signed-off-by: Tim 'mithro' Ansell --- .readthedocs.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 4f57057..9cf5e30 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -19,13 +19,19 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required version: 2 +build: + os: ubuntu-lts-latest + tools: + python: latest + +# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py fail_on_warning: false python: - version: "3.7" install: - requirements: docs/requirements.txt From 38a227b00a2dba1b9105f8f00f4536df20b9f4ea Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 23 Mar 2024 09:46:37 -0700 Subject: [PATCH 2/3] Remove sphinx version pin. Signed-off-by: Tim 'mithro' Ansell --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index de55921..b4c11c9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==4.5.0 +sphinx docutils git+https://github.com/f4pga/sphinx_f4pga_theme.git@f4pga#egg=sphinx-f4pga-theme sphinx-tabs From e12625612fa4da65654babbbf5f4c5deff21c80a Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Sat, 23 Mar 2024 09:53:45 -0700 Subject: [PATCH 3/3] Pin docutils to fix error. ``` Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/f4pga-examples/envs/385/lib/python3.12/site-packages/docutils/statemachine.py", line 299, in next_line self.line = self.input_lines[self.line_offset] ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/f4pga-examples/envs/385/lib/python3.12/site-packages/docutils/statemachine.py", line 1136, in __getitem__ return self.data[i] ~~~~~~~~~^^^ IndexError: list index out of range ``` Signed-off-by: Tim 'mithro' Ansell --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index b4c11c9..7c2b567 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ docutils git+https://github.com/f4pga/sphinx_f4pga_theme.git@f4pga#egg=sphinx-f4pga-theme sphinx-tabs sphinx-jinja +docutils==0.17.1