From 08420087e852d52b565dd4be8a7f119da130fbcc Mon Sep 17 00:00:00 2001 From: Henry Date: Fri, 28 Jul 2023 10:34:49 +0200 Subject: [PATCH] :memo: add configuration for readthedocs --- .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++ docs/requirements.txt | 3 +++ 2 files changed, 35 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..273f0545e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,32 @@ +# .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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.8" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +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 000000000..76fc06d84 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +myst-parser +sphinx-book-theme \ No newline at end of file