.readthedocs.yaml

# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for detail
version: "2"

# Requirements are based on build_env.Dockerfile

# Set the OS, Python version and other tools you might need
build:
  os: "ubuntu-20.04"
  tools:
    python: "3.10"
  apt_packages:
    - "build-essential"
    - "flex"
    - "bison"
    - xxd
    # Python3 with pip (thus wheel), and presumably python3-venv, are already installed.
    - libosmesa6 # for easier opengl renders
    - firefox
    # - chromium-browser
    # - google-chrome
    # - snapd
  jobs:
    post_create_environment:
      - pip install auditwheel patchelf
    pre_install:
      - echo "pre install, make it"
      - echo "$PATH"
      # - google-chrome --version
    post_install:
      # Snap (which is the only way to install chromium in '20 and firefox+chromium after that) can't work under docker :c https://forums.docker.com/t/snap-in-dockerfile/136997/2
      # - systemctl start snapd.service
      # - service snapd start
      - bash rtd_post_install.bash
      - firefox --version
      # - chromium-browser --version

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/source/conf.py
  fail_on_warning: true
  

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
   install:
   - requirements: docs/requirements.txt
   # Install our python package before building the docs
   - method: pip
     path: .