xref: /libCEED/.readthedocs.yml (revision c990f8961b80e822ea3737ac6f36ee8a75725393)
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
7*c990f896SJed Brownbuild:
8*c990f896SJed Brown  os: ubuntu-22.04
9*c990f896SJed Brown  tools:
10*c990f896SJed Brown    python: "3.11"
11*c990f896SJed Brown    nodejs: "19"
12*c990f896SJed Brown  apt_packages:
13*c990f896SJed Brown    - librsvg2-bin
14*c990f896SJed Brown  jobs:
15*c990f896SJed Brown    post_create_environment:
16*c990f896SJed Brown      - npm install -g @mermaid-js/mermaid-cli
17*c990f896SJed Brown
184c4400c7SValeria Barra# Build documentation in the docs/ directory with Sphinx
194c4400c7SValeria Barrasphinx:
20f6d735e9SValeria Barra  builder: dirhtml
214c4400c7SValeria Barra  configuration: doc/sphinx/source/conf.py
224c4400c7SValeria Barra
234c4400c7SValeria Barra# Optionally build your docs in additional formats such as PDF and ePub
249c6151e5SJed Brownformats:
259c6151e5SJed Brown  - pdf
264c4400c7SValeria Barra
274c4400c7SValeria Barra# Optionally set the version of Python and requirements required to build your docs
284c4400c7SValeria Barrapython:
294c4400c7SValeria Barra  install:
304c4400c7SValeria Barra    - requirements: doc/sphinx/requirements.txt
31