.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.12"
  12     # You can also specify other tool versions:
  13     # nodejs: "20"
  14     # rust: "1.70"
  15     # golang: "1.20"
  16   apt_packages:
  17     - libacl1-dev
  18   jobs:
  19     pre_build:
  20       - make posix1e.so
  21
  22 # Build documentation in the "docs/" directory with Sphinx
  23 sphinx:
  24   configuration: doc/conf.py
  25   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  26   # builder: "dirhtml"
  27   # Fail on all warnings to avoid broken references
  28   # fail_on_warning: true
  29
  30 # Optionally build your docs in additional formats such as PDF and ePub
  31 # formats:
  32 #   - pdf
  33 #   - epub
  34
  35 # Optional but recommended, declare the Python requirements required
  36 # to build your documentation
  37 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
  38 python:
  39   install:
  40     - requirements: doc/requirements.txt