Fix: Add RTD docs build configuration file

Also, exclude node_modules directory from linting tools Issue: RELENG-5212 Change-Id: I73d2880bac202da76e411f636bdde3cbef1c974b Signed-off-by: Matthew Watkins <[email protected]>
lfit · Mar 13, 2024 · 41a28a8 · 41a28a8
1 parent c9cd393
commit 41a28a8
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ docs/_build/
 cloud-env.json
 *.pyc
 *.retry
+node_modules/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,27 @@
+# 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.10"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# 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