.readthedocs.yaml

# .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 version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"
  jobs:
    pre_build:
      # Generate stub carousel files before building documentation
      # The actual carousel files are normally auto-generated during PyVista's full build
      # but that requires extensive dependencies. For translation builds, stubs are sufficient.
      - python generate_carousel_stubs.py

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
#    - pdf

# Optionally declare the Python requirements required to build your docs
python:
  install:
    - requirements: requirements.txt

submodules:
  include:
    - pyvista
  recursive: true