WEIS/.readthedocs.yaml at main · NLRWindSystems/WEIS · 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
51
52
53
54
55
56
57
58
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    #python: "3.12"
    python: "mambaforge-latest"
  apt_packages:
      - snapd
      - gfortran
      - cmake
  jobs:
    # Read the docs needs a couple packages not in the environment file
    pre_install:
      #- pip install --upgrade pip pytest numpy numpydoc windIO
      - conda install -y compilers sphinx sphinxcontrib-bibtex sphinx-jsonschema sphinxcontrib-video
      - conda install sphinx_rtd_theme>=1.3
      #- pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme
      - pip install json-schema-for-humans
    pre_build:
      - pwd
      - ls
      - pip install -e .
      - python -c "import weis.inputs.validation as vd; vd.wisval.write_yaml(vd.get_geometry_schema(), vd.fschema_geom)"
      - python -c "import weis.inputs.validation as vd; vd.wisval.write_yaml(vd.get_modeling_schema(), vd.fschema_model)"
      - python -c "import weis.inputs.validation as vd; vd.wisval.write_yaml(vd.get_analysis_schema(), vd.fschema_opt)"
      - generate-schema-doc --no-copy-css --no-copy-js weis/inputs/modeling_schema.yaml docs/_static/modeling_doc.html
      - generate-schema-doc --no-copy-css --no-copy-js weis/inputs/geometry_schema.yaml docs/_static/geometry_doc.html
      - generate-schema-doc --no-copy-css --no-copy-js weis/inputs/analysis_schema.yaml docs/_static/analysis_doc.html


# Shouldn't need conda for building the docs, but it is an option
conda:
  environment: environment.yml


# Build documentation in the docs/ directory with Sphinx
sphinx:
   configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
#    - pdf

# Optionally declare the Python requirements required to build your docs
python:
  install:
    - method: pip
      path: .
      extra_requirements:
        - docs
#  system_packages: true