Skip to content

Commit e46da4d

Browse files
committed
Update to modern .readthedocs.yaml
1 parent aeffd40 commit e46da4d

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

.readthedocs.yaml

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# .readthedocs.yaml
22
# Read the Docs configuration file
3-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
# See https://docs.readthedocs.com/platform/stable/config-file/v2.html for details
44

55
# Required
66
version: 2
@@ -11,27 +11,26 @@ build:
1111
tools:
1212
python: "3.12"
1313
nodejs: "20"
14-
jobs:
15-
post_checkout:
16-
# Cancel building pull requests when there aren't changes in the docs directory or YAML file.
17-
# You can add any other files or directories that you'd like here as well,
18-
# like your docs requirements file, or other files that will change your docs build.
19-
#
20-
# If there are no changes (git diff exits with 0) we force the command to return with 183.
21-
# This is a special exit code on Read the Docs that will cancel the build immediately.
22-
- |
23-
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt packages/volto/.storybook;
24-
then
25-
exit 183;
26-
fi
27-
post_install:
28-
# Install dependencies defined in your ``package.json``
29-
# - npm ci
30-
# Install any other extra dependencies to build the docs
31-
- corepack enable
32-
- corepack prepare pnpm@* --activate
33-
- asdf reshim nodejs
34-
- pnpm install
35-
- pnpm build:registry
36-
- (cd packages/volto && pnpm build-storybook -o ${READTHEDOCS_OUTPUT}/html/storybook)
37-
- make docs-rtd-pr-preview
14+
commands:
15+
# Cancel building pull requests when there aren't changes in the docs directory or YAML file.
16+
# You can add any other files or directories that you'd like here as well,
17+
# like your docs requirements file, or other files that will change your docs build.
18+
#
19+
# If there are no changes (git diff exits with 0) we force the command to return with 183.
20+
# This is a special exit code on Read the Docs that will cancel the build immediately.
21+
- |
22+
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt packages/volto/.storybook;
23+
then
24+
exit 183;
25+
fi
26+
# Install dependencies defined in your ``package.json``
27+
# - npm ci
28+
# Install any other extra dependencies to build the docs
29+
- npm i -g corepack@latest
30+
- corepack enable
31+
- corepack prepare pnpm@* --activate
32+
- asdf reshim nodejs
33+
- pnpm install
34+
- pnpm build:registry
35+
- (cd packages/volto && pnpm build-storybook -o ${READTHEDOCS_OUTPUT}/html/storybook)
36+
- make docs-rtd-pr-preview

0 commit comments

Comments
 (0)