readthedocs.yml

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html

build:
version: 2

# Note: Rustdoc generation is skipped on RTD due to Bevy's complex build dependencies.
# The CI workflow (docs-main.yml) generates full docs with embedded rustdoc as an artifact.
# RTD builds use SPHINX_SKIP_RUSTDOC=1 and link to docs.rs for API reference instead.


# Build documentation in the docs/ directory with Sphinx

build:
  os: ubuntu-22.04
  tools:
    python: "3.13"
sphinx:
  configuration: docs/conf.py
  builder: html
  fail_on_warning: true

# Python requirements for Sphinx
python:
  install:
    - requirements: docs/requirements.txt

# Build documentation for these formats
formats:
  - htmlzip

# Version selector: build from tags and main branch
# RTD automatically builds:
# - All tags matching semantic versioning (v*.*.*)
# - The default branch (main)
# - Any branches/tags activated in the RTD dashboard
# The version selector flyout appears automatically when multiple versions exist