mirror of
https://github.com/EttusResearch/uhd.git
synced 2026-10-25 17:36:10 +00:00
f6733edc53
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.
33 lines
803 B
YAML
33 lines
803 B
YAML
# .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
|