Adding readthedocs configuration file
All checks were successful
Test with tox / Test with tox (3.11) (push) Successful in 1m12s
Build Sphinx Docs Set / Build Docs (push) Successful in 1m33s
Build Project / Build Project (3.10) (push) Successful in 1m48s
Test with tox / Test with tox (3.12) (push) Successful in 1m9s
Test with tox / Test with tox (3.10) (push) Successful in 2m27s
Build Project / Build Project (3.12) (push) Successful in 2m37s
Build Project / Build Project (3.11) (push) Successful in 2m40s

This commit is contained in:
Michael Luciuk 2025-09-05 10:31:29 -04:00
parent 1f0f4f6fb4
commit 871c9a219c

24
.readthedocs.yaml Normal file
View File

@ -0,0 +1,24 @@
# 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.10"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now, see #11150
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
sphinx:
configuration: docs/conf.py