openEMS-Project/.readthedocs.yaml at master · thliebig/openEMS-Project · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# formats for offline edition
formats:
  - htmlzip

# Set the OS, Python version, and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    python: "3.13"
  apt_packages:
    # Octave must be installed for generating Octave docs
    - octave

    # openEMS and Python modules must be installed for generating Python docs
    - build-essential
    - git
    - libhdf5-dev
    - libtinyxml-dev
    - libvtk9-dev
    - libboost-all-dev
    - libcgal-dev
    - cmake

  jobs:
    # Make sure it runs just after ReadTheDocs created the Python virtualenv,
    # but before it actually installs doc-src/requirements.txt (because we
    # need to install CSXCAD and openEMS first).
    pre_install:
      - . $READTHEDOCS_VIRTUALENV_PATH/bin/activate
      - ./update_openEMS.sh $HOME/opt/ --python --disable-GUI || cat build_*

submodules:
  include:
    - fparser
    - CSXCAD
    - openEMS

python:
  install:
    - requirements: doc-src/requirements.txt

sphinx:
  # Path to your Sphinx configuration file.
  configuration: doc-src/conf.py