Skip to content

Commit ffbc8fc

Browse files
authored
Linkcheck fixes (#1837)
1 parent ad1a353 commit ffbc8fc

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
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

docs/contributing/documentation/admins.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -151,18 +151,18 @@ In addition, you should consider configure Read the Docs for the following.
151151
With this configuration and setup, you will also continue to have pull request preview builds.
152152

153153
```{seealso}
154-
- [`robots.txt` support](https://docs.readthedocs.io/en/stable/reference/robots.html)
155-
- [Automation rules](https://docs.readthedocs.io/en/stable/automation-rules.html)
156-
- [Versions](https://docs.readthedocs.io/en/stable/versions.html)
157-
- [Managing versions automatically](https://docs.readthedocs.io/en/stable/guides/automation-rules.html)
154+
- [`robots.txt` support](https://docs.readthedocs.com/platform/stable/reference/robots.html)
155+
- [Automation rules](https://docs.readthedocs.com/platform/stable/automation-rules.html)
156+
- [Versions](https://docs.readthedocs.com/platform/stable/versions.html)
157+
- [Managing versions automatically](https://docs.readthedocs.com/platform/stable/guides/automation-rules.html)
158158
```
159159

160160

161161
### Cancel builds programmatically
162162

163163
You might want to cancel a build programmatically when certain conditions are met.
164164
You can do this through your {file}`.readthedocs.yaml` file.
165-
Read the Docs covers a few scenarios in its documentation, [Cancel build based on a condition](https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition).
165+
Read the Docs covers a few scenarios in its documentation, [Cancel build based on a condition](https://docs.readthedocs.com/platform/stable/build-customization.html).
166166

167167

168168
#### Build only on changes
@@ -178,19 +178,19 @@ build:
178178
os: "ubuntu-22.04"
179179
tools:
180180
python: "3.12"
181-
jobs:
182-
post_checkout:
183-
# Cancel building pull requests when there aren't changes in the docs directory or YAML file.
184-
# You can add any other files or directories that you'd like here as well,
185-
# like your docs requirements file, or other files that will change your docs build.
186-
#
187-
# If there are no changes (git diff exits with 0) we force the command to return with 183.
188-
# This is a special exit code on Read the Docs that will cancel the build immediately.
189-
- |
190-
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-initial.txt requirements.txt;
191-
then
192-
exit 183;
193-
fi
181+
commands:
182+
# Cancel building pull requests when there aren't changes in the docs directory or YAML file.
183+
# You can add any other files or directories that you'd like here as well,
184+
# like your docs requirements file, or other files that will change your docs build.
185+
#
186+
# If there are no changes (git diff exits with 0) we force the command to return with 183.
187+
# This is a special exit code on Read the Docs that will cancel the build immediately.
188+
- |
189+
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-initial.txt requirements.txt;
190+
then
191+
exit 183;
192+
fi
193+
# build.commands to build docs
194194
```
195195

196196

@@ -208,7 +208,7 @@ build:
208208
jobs:
209209
post_checkout:
210210
# Cancel the Read the Docs build
211-
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
211+
# https://docs.readthedocs.com/platform/stable/build-customization.html
212212
- exit 183;
213213
```
214214

0 commit comments

Comments
 (0)