xref: /libCEED/.readthedocs.yml (revision c5a41aec3f06ad4e8ccb2139dcac9574697db9f7)
14c4400c7SValeria Barra# Read the Docs configuration file
24c4400c7SValeria Barra# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
34c4400c7SValeria Barra
44c4400c7SValeria Barra# Required
54c4400c7SValeria Barraversion: 2
64c4400c7SValeria Barra
7c990f896SJed Brownbuild:
8*c5a41aecSJeremy L Thompson  os: ubuntu-24.04
9c990f896SJed Brown  tools:
10*c5a41aecSJeremy L Thompson    python: "3.13"
11*c5a41aecSJeremy L Thompson    nodejs: "23"
12c990f896SJed Brown  apt_packages:
13c990f896SJed Brown    - librsvg2-bin
14c990f896SJed Brown  jobs:
15c990f896SJed Brown    post_create_environment:
16*c5a41aecSJeremy L Thompson      - npx playwright install
17c990f896SJed Brown      - npm install -g @mermaid-js/mermaid-cli
18c990f896SJed Brown
194c4400c7SValeria Barra# Build documentation in the docs/ directory with Sphinx
204c4400c7SValeria Barrasphinx:
21f6d735e9SValeria Barra  builder: dirhtml
224c4400c7SValeria Barra  configuration: doc/sphinx/source/conf.py
234c4400c7SValeria Barra
244c4400c7SValeria Barra# Optionally build your docs in additional formats such as PDF and ePub
259c6151e5SJed Brownformats:
269c6151e5SJed Brown  - pdf
274c4400c7SValeria Barra
284c4400c7SValeria Barra# Optionally set the version of Python and requirements required to build your docs
294c4400c7SValeria Barrapython:
304c4400c7SValeria Barra  install:
314c4400c7SValeria Barra    - requirements: doc/sphinx/requirements.txt
32