From 640d27105a407de2105cd3a9a8586273bcd5af1b Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Tue, 16 Nov 2021 12:26:48 -0800 Subject: [PATCH] Add RTD configs to get generator working Signed-off-by: Stephen Curran --- docs/readthedocs.yaml | 17 +++++++++++++++++ docs/requirements.txt | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 docs/readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/docs/readthedocs.yaml b/docs/readthedocs.yaml new file mode 100644 index 0000000000..58126736d6 --- /dev/null +++ b/docs/readthedocs.yaml @@ -0,0 +1,17 @@ +# Configuration for RTDs generation + +version: 2 + +build: + os: "ubuntu-20.04" + tools: + python: "3.7" + +# Build from the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Explicitly set the version of Python and its requirements +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..08cf22af4b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +# Defining the exact versions for ReadTheDocs that will make sure things don't break +sphinx==4.2.0 +sphinx_rtd_theme==1.0.0 +readthedocs-sphinx-search==0.1.1 \ No newline at end of file