aboutsummaryrefslogtreecommitdiffstats
path: root/.readthedocs.yaml
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2022-01-21 15:36:22 +0100
committerAaron Rossetto <aaron.rossetto@ni.com>2022-02-01 14:48:56 -0600
commitf6733edc53f9c85c3b3ce67ee766181aa96b99ca (patch)
treeac56f94f70b71d0d7ef2242f80b37448531b3284 /.readthedocs.yaml
parent930fa39c601d1601884ca6ead9f44841f0348f18 (diff)
downloaduhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.tar.gz
uhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.tar.bz2
uhd-f6733edc53f9c85c3b3ce67ee766181aa96b99ca.zip
docs: Add shim Sphinx config for readthedocs
This adds a faux Sphinx project under host/docs. When invoking sphinx, it will in fact forward the generator request to Doxygen. This is useful for generating the UHD manual, e.g., on readthedocs. To enable the latter service, .readthedocs.yaml and environment.yml files were added as well.
Diffstat (limited to '.readthedocs.yaml')
-rw-r--r--.readthedocs.yaml32
1 files changed, 32 insertions, 0 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..a2a2cb0ac
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# .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-20.04
+ #tools:
+ #python: "3.9"
+ # You can also specify other tool versions:
+ # nodejs: "16"
+ # rust: "1.55"
+ # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: host/docs/sphinx/source/conf.py
+
+conda:
+ environment: host/docs/sphinx/environment.yml
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+# - pdf
+
+# Optionally declare the Python requirements required to build your docs
+#python:
+ #install:
+ #- requirements: host/docs/sphinx/requirements.txt