.readthedocs.yml

# SPDX-FileCopyrightText: PyPSA Contributors
#
# SPDX-License-Identifier: MIT

version: 2

build:
  os: ubuntu-24.04
  tools:
    python: "3.13"
  jobs:
    pre_system_dependencies:
    - git fetch --unshallow   # Needed to get version tags
    pre_create_environment:
    - asdf plugin add uv
    - asdf install uv latest
    - asdf global uv latest
    create_environment:
    - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
    install:
    - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv pip install -r docs/requirements.txt
    pre_build:
    - printf '%b' "$GUROBI_LIC" > $HOME/gurobi.lic
    - python -c "p=\"$HOME/gurobi.lic\";t=open(p).read().replace(chr(39),\"\");open(p,\"w\").write(t)"
      # To create all doctest files
    - PYPSA_PARAMS__OPTIMIZE__SOLVER_NAME=gurobi uv run pytest test/test_docs.py --test-docs

mkdocs:
  configuration: mkdocs.yml
  fail_on_warning: true