From 35240b25ba848708198267290a257406b71ecff6 Mon Sep 17 00:00:00 2001 From: Matthew Grove Date: Sat, 7 Jan 2023 20:27:22 +0000 Subject: [PATCH] [BUILD] Add RTD config file --- .dockerignore | 3 ++- .readthedocs.yaml | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.dockerignore b/.dockerignore index f4f42a5..e523cef 100644 --- a/.dockerignore +++ b/.dockerignore @@ -17,4 +17,5 @@ mail.log/ *.log* deployment* -docs/ \ No newline at end of file +docs/ +.readthedocs.yaml \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..b49745b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,24 @@ +# .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-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# 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: