Install read_the_docs theme in .readthedocs.yaml (#2029)

ni-jfitzger · web-flow · commit d92f58a6ffbe · 2023-10-24T09:35:13.000-05:00
* Install read_the_docs theme in .readthedocs.yaml

* Attempt 2 - add requirements file (kind of)
diff --git a/build/templates/.readthedocs.yaml.mako b/build/templates/.readthedocs.yaml.mako
@@ -52,9 +52,9 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
+# Declare the Python requirements required to build your docs
 ## TODO(ni-jfitzger): Create requirements file for docs to make builds reproducible. See https://github.com/ni/nimi-python/issues/1968
 ## Note: Our nimi-python readthedocs project used the defaults here: https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nidcpower/.readthedocs.yaml b/docs/nidcpower/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nidigital/.readthedocs.yaml b/docs/nidigital/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nidmm/.readthedocs.yaml b/docs/nidmm/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nifgen/.readthedocs.yaml b/docs/nifgen/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nimodinst/.readthedocs.yaml b/docs/nimodinst/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/niscope/.readthedocs.yaml b/docs/niscope/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nise/.readthedocs.yaml b/docs/nise/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/niswitch/.readthedocs.yaml b/docs/niswitch/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/nitclk/.readthedocs.yaml b/docs/nitclk/.readthedocs.yaml
@@ -45,7 +45,7 @@ formats:
   - epub
   - pdf
 
-# Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+# Declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,4 @@
+# This isn't a full-fledged requirements file, yet. It's just a single unpinned dependency that we needed to fix our documentation builds.
+# TODO(ni-jfitzger): Create requirements file for docs to make builds reproducible. See https://github.com/ni/nimi-python/issues/1968
+# Note: Our nimi-python readthedocs project used the defaults here: https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies
+sphinx_rtd_theme
