From cc7394164633e75fb61d52565f75271e0b7f1236 Mon Sep 17 00:00:00 2001 From: Andrew Cooper Date: Mon, 16 Oct 2023 16:56:43 +0100 Subject: [PATCH] docs: Introduce a default .readthedocs.yaml Read The Docs now requires a configuration file, which is awkward when using RTD to render proposed changes on the list. Provide the minimal configuration file possible, sacrificing all reproducibility in order to hopefully not need to touch it moving forwards. Signed-off-by: Andrew Cooper Reviewed-by: Stefano Stabellini --- .readthedocs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..d3aff7662e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,18 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-lts-latest + + tools: + python: "latest" + + jobs: + post_install: + # Instead of needing a separate requirements.txt + - python -m pip install --upgrade --no-cache-dir sphinx-rtd-theme + +sphinx: + configuration: docs/conf.py