aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/sphinx/source/index.rst
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 /host/docs/sphinx/source/index.rst
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 'host/docs/sphinx/source/index.rst')
-rw-r--r--host/docs/sphinx/source/index.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/host/docs/sphinx/source/index.rst b/host/docs/sphinx/source/index.rst
new file mode 100644
index 000000000..f62125e5f
--- /dev/null
+++ b/host/docs/sphinx/source/index.rst
@@ -0,0 +1,10 @@
+.. UHD documentation master file, created by sphinx-quickstart.
+ This is a dummy file, it will be ignored and its result will be overwritten.
+
+Welcome to UHD's documentation!
+===============================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+