From 4b5f14b1f10f54656d1bf46eb98a20b91cb6626c Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Tue, 5 Dec 2023 12:59:08 -0500 Subject: [PATCH] docs: move the config file RTD can sometimes be particular about the suffix. So update to `.yaml` instead of `.yml`. Also update the config to match the latest valid RTD config for build.os --- .readthedocs.yml => .readthedocs.yaml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) rename .readthedocs.yml => .readthedocs.yaml (51%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 51% rename from .readthedocs.yml rename to .readthedocs.yaml index 76ad95e..6d7a189 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yaml @@ -2,7 +2,7 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required +# Required: the version of this file's schema. version: 2 # Build documentation in the docs/ directory with Sphinx @@ -10,7 +10,18 @@ sphinx: configuration: docs/source/conf.py fail_on_warning: true +# Optionally build your docs in additional formats such as PDF +# formats: +# - pdf +# - epub + +# Set the version of python needed to build these docs. +build: + os: "ubuntu-22.04" + tools: + python: "3.8" + +# Optionally set the requirements required to build your docs python: - version: 3.8 install: - requirements: requirements/docs.txt