From 17220a03bc8ce97a2c7bfa76e7eb5782aa7b1f3c Mon Sep 17 00:00:00 2001 From: Francesca Capel Date: Thu, 1 Feb 2024 13:53:06 +0100 Subject: [PATCH] Update .readthedocs.yml --- .readthedocs.yml | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 6f00923b..92897e21 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,23 +1,35 @@ -# .readthedocs.yml -# Read the Docs configuration file +# Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 -# Build documentation in the docs/ directory with Sphinx +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.7" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub -formats: all +# formats: +# - pdf +# - epub -# Optionally set the version of Python and requirements required to build your docs +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: 3.7 install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt