mirror of
https://github.com/ROCm/jax.git
synced 2025-04-19 13:26:06 +00:00
32 lines
985 B
YAML
32 lines
985 B
YAML
# .readthedocs.yml
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
build:
|
|
os: "ubuntu-22.04"
|
|
tools:
|
|
python: "3.10"
|
|
jobs:
|
|
post_checkout:
|
|
# Skip building PRs unless tagged with the "documentation" label.
|
|
- |
|
|
[ "${READTHEDOCS_VERSION_TYPE}" != "external" ] && echo "Building latest" && exit 0
|
|
(curl -sL https://api.github.com/repos/jax-ml/jax/issues/${READTHEDOCS_VERSION}/labels | grep -q "https://api.github.com/repos/jax-ml/jax/labels/documentation") && echo "Building PR with label" || exit 183
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/conf.py
|
|
fail_on_warning: true
|
|
|
|
# Optionally build your docs in additional formats such as PDF and ePub
|
|
formats:
|
|
- htmlzip
|
|
|
|
# Optionally set the version of Python and requirements required to build your docs
|
|
python:
|
|
install:
|
|
- requirements: docs/requirements.txt
|