]> git.puffer.fish Git - matthieu/frr.git/commitdiff
doc: add .readthedocs.yaml configs
authorQuentin Young <qlyoung@qlyoung.net>
Thu, 28 Sep 2023 00:14:46 +0000 (20:14 -0400)
committerQuentin Young <qlyoung@qlyoung.net>
Thu, 28 Sep 2023 00:16:16 +0000 (20:16 -0400)
As of Sep 25 2023, RTD projects require config files to build. This
patch is necessary for docs to continue to build.

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
doc/developer/.readthedocs.yaml [new file with mode: 0644]
doc/user/.readthedocs.yaml [new file with mode: 0644]

diff --git a/doc/developer/.readthedocs.yaml b/doc/developer/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..9acbedb
--- /dev/null
@@ -0,0 +1,16 @@
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/developer/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt
diff --git a/doc/user/.readthedocs.yaml b/doc/user/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..ed44aef
--- /dev/null
@@ -0,0 +1,16 @@
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/user/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt