-
Notifications
You must be signed in to change notification settings - Fork 216
/
.readthedocs.yaml
48 lines (43 loc) · 1.34 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
# 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: "mambaforge-23.11"
jobs:
post_checkout:
# Cancel building pull requests when there aren't changes related to docs.
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && \
git diff --quiet origin/main -- \
doc/ \
examples \
pygmt/**/*.py \
':!pygmt/tests' \
README.md \
ci/requirements/docs.yml \
.readthedocs.yaml;
then
exit 183;
fi
pre_build:
# Generate api stub files before building
- make -C doc api
# Build documentation in the doc/ directory with Sphinx
sphinx:
configuration: doc/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
conda:
environment: ci/requirements/docs.yml
python:
install:
- method: pip
path: .