forked from WISDEM/WISDEM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.readthedocs.yaml
53 lines (45 loc) · 1.77 KB
/
.readthedocs.yaml
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
# .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-22.04
tools:
# This leads to "excessive memory use"
#python: "miniconda-latest"
python: "mambaforge-22.9"
apt_packages:
- snapd
jobs:
# Read the docs needs a couple packages not in the environment file
pre_install:
- conda install -y cmake compilers sphinx sphinxcontrib-bibtex
- conda install sphinx_rtd_theme>=1.3
pre_build:
- pwd
- wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O yq && chmod +x yq
- ./yq -p yaml -o json wisdem/inputs/analysis_schema.yaml >| docs/schema/analysis_schema.json
- ./yq -p yaml -o json wisdem/inputs/modeling_schema.yaml >| docs/schema/modeling_schema.json
- sed -i -s '0,/properties/s//definitions/' docs/schema/modeling_schema.json
- sed -i -s '0,/properties/s//definitions/' docs/schema/analysis_schema.json
#- sed -i -s -e '/properties/{s//definitions/;:a' -e '$!N;$!ba' -e '}' docs/schema/modeling_schema.json
#- sed -i -s -e '/properties/{s//definitions/;:a' -e '$!N;$!ba' -e '}' docs/schema/analysis_schema.json
# 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