From fae7a4ecc3f50f62d3fbc814127ddce439df6abe Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Sun, 8 Oct 2023 20:58:04 -0400 Subject: [PATCH] docs: add RTD configuration file (#35) * docs: add RTD configuration file See https://blog.readthedocs.com/migrate-configuration-v2/ * fix path --- .readthedocs.yaml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..d56afbe --- /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.10" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: all + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: docs/requirements.txt