Skip to content
Snippets Groups Projects
.readthedocs.yaml 793 B
Newer Older
James Briggs's avatar
James Briggs committed
# .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 OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  tools:
jamescalam's avatar
jamescalam committed
    python: "3.13"
James Briggs's avatar
James Briggs committed
    # You can also specify other tool versions:
    # nodejs: "19"
    # rust: "1.64"
    # golang: "1.19"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
James Briggs's avatar
James Briggs committed
  configuration: ./docs/source/conf.py
James Briggs's avatar
James Briggs committed

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
#    - pdf
#    - epub

James Briggs's avatar
James Briggs committed
# Declare the Python requirements required to build docs
James Briggs's avatar
James Briggs committed
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
James Briggs's avatar
James Briggs committed
python:
   install:
   - requirements: ./docs/source/requirements.txt