fix readthedocs build (#1040) to support the new requirements

kermitt2 · Aug 24, 2023 · d12d6a2 · d12d6a2
1 parent 2c720dd
commit d12d6a2
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1 @@
+mkdocs==1.5.1
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,7 +8,7 @@ plugins:
  - search
 theme:
  name: readthedocs
-pages:
+nav:
  - Home: 'index.md'
  - About:
  - 'Introduction': 'Introduction.md'

diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,20 @@
+# .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-22.04
+ tools:
+ python: "3.11"
+
+python:
+ install:
+ - requirements: doc/requirements.txt
+
+mkdocs:
+ configuration: mkdocs.yml
+ fail_on_warning: false