From 02c39ca09e6576f3b8777909f86b588715a13277 Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Sat, 17 Dec 2022 22:33:23 -0800 Subject: [PATCH 1/3] update readthedocs build process --- .readthedocs.yaml | 21 ++++++++++++++++++++ doc-requirements.txt => doc/requirements.txt | 0 2 files changed, 21 insertions(+) create mode 100644 .readthedocs.yaml rename doc-requirements.txt => doc/requirements.txt (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..79afa7451 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,21 @@ +# .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-20.04 + tools: + python: "3.9" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt diff --git a/doc-requirements.txt b/doc/requirements.txt similarity index 100% rename from doc-requirements.txt rename to doc/requirements.txt From b7f394ce47239097f039c454a4b9dcc5f49fa198 Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Sat, 17 Dec 2022 22:57:04 -0800 Subject: [PATCH 2/3] pin docutils to 0.16 until sphinx_rtd_theme is fixed https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 --- doc/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/requirements.txt b/doc/requirements.txt index cf1a3a76e..123dcc0a2 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -6,3 +6,4 @@ sphinx_rtd_theme numpydoc ipykernel nbsphinx +docutils==0.16 # pin until sphinx_rtd_theme is compatible with 0.17 or later From 7278651aa11e311a0ca2bf0dc300a75d39f06cc4 Mon Sep 17 00:00:00 2001 From: Richard Murray Date: Sun, 18 Dec 2022 08:08:02 -0800 Subject: [PATCH 3/3] use ubuntu-22.04 --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 79afa7451..dca7c8bc4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ version: 2 # Set the version of Python and other tools you might need build: - os: ubuntu-20.04 + os: ubuntu-22.04 tools: python: "3.9"