.readthedocs.yaml

   1 # Read the Docs configuration file for Sphinx projects
   2 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
   3
   4 # Required
   5 version: 2
   6
   7 # Set the OS, Python version and other tools you might need
   8 build:
   9   os: ubuntu-22.04
  10   tools:
  11     python: "3.11"
  12
  13 # Build documentation in the "Documentation/" directory with Sphinx
  14 sphinx:
  15   configuration: Documentation/conf.py
  16   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  17   # builder: "dirhtml"
  18   # Fail on all warnings to avoid broken references
  19   # fail_on_warning: true
  20
  21 # Optionally build your docs in additional formats such as PDF and ePub
  22 # formats:
  23 #   - pdf
  24 #   - epub
  25
  26 # Optional but recommended, declare the Python requirements required
  27 # to build your documentation
  28 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
  29 python:
  30   install:
  31     - requirements: Documentation/requirements.txt