forked from ESMValGroup/ESMValCore
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
31 lines (26 loc) · 847 Bytes
/
Copy path.readthedocs.yaml
File metadata and controls
31 lines (26 loc) · 847 Bytes
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
# .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-lts-latest
tools:
# try miniforge3 when available? see github.com/ESMValGroup/ESMValCore/issues/2557
# DO NOT use mambaforge-*; that is currently sunsetted
python: "miniconda-latest"
jobs:
post_create_environment:
- conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps
# Declare the requirements required to build your docs
conda:
environment:
environment.yml
# Build documentation in the doc directory with Sphinx
sphinx:
configuration: doc/conf.py
fail_on_warning: true
# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf