📚 Fix RTD build (#832)

executablebooks · Nov 24, 2023 · f313a09 · f313a09
1 parent ebf989f
commit f313a09
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,7 +1,11 @@
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
 python:
-  version: "3.8"
   install:
       - method: pip
         path: .

diff --git a/docs/syntax/optional.md b/docs/syntax/optional.md
@@ -622,7 +622,7 @@ based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/r
   ```
 :::
 
-A prominent use case of field lists is for use in API docstrings, as used in [Sphinx's docstring renderers](inv:sphinx#python-domain):
+A prominent use case of field lists is for use in API docstrings, as used in [Sphinx's docstring renderers](inv:sphinx#usage/domains/python):
 
 :::{myst-example}
 ```{py:function} send_message(sender, priority)

diff --git a/pyproject.toml b/pyproject.toml
@@ -64,6 +64,7 @@ rtd = [
     "sphinx-pyscript",
     "sphinx-tippy>=0.3.1",
     "sphinx-autodoc2~=0.4.2",
+    "astroid<3",  # see https://github.com/sphinx-extensions2/sphinx-autodoc2/issues/31
     "sphinx-togglebutton",
 ]
 testing = [