uhd/host/docs/sphinx/source/index.rst
Martin Braun 97160d6ade 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.
2022-01-24 10:01:41 +01:00

21 lines
425 B
ReStructuredText

.. UHD documentation master file, created by
sphinx-quickstart on Fri Jan 21 15:33:40 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to UHD's documentation!
===============================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`