]> xenbits.xensource.com Git - people/andrewcoop/xen.git/commitdiff
Default .rtd.yaml
authorAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 16 Oct 2023 15:56:43 +0000 (16:56 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Fri, 3 Jan 2025 20:44:42 +0000 (20:44 +0000)
.readthedocs.yaml [new file with mode: 0644]
docs/requirements.txt [new file with mode: 0644]

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..c3c3f96
--- /dev/null
@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..483a4e9
--- /dev/null
@@ -0,0 +1 @@
+sphinx_rtd_theme