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