Skip to content

Commit b5455c5

Browse files
authored
Fail CI if broken links in the docs (#9877)
* Fail CI if broken links in the docs * Fix broken links in the docs
1 parent b47b366 commit b5455c5

12 files changed

Lines changed: 13 additions & 14 deletions

.github/workflows/main.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ jobs:
7171
- run: if [ $WAIT_TIME == 5 ]; then echo cannot start mkdocs server on http://localhost:8000; exit 1; fi
7272

7373
- name: Check links
74-
continue-on-error: true
7574
run: pylinkvalidate.py -P http://localhost:8000/
7675

7776
- run: echo "Done"

docs/community/3.10-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,4 +145,4 @@ continued development by **[signing up for a paid plan][funding]**.
145145

146146
[legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/3.14.0/docs/coreapi/index.md
147147
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
148-
[funding]: funding.md
148+
[funding]: https://opencollective.com/django-rest-framework

docs/community/3.11-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ continued development by **[signing up for a paid plan][funding]**.
111111
*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), and [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship).*
112112

113113
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
114-
[funding]: funding.md
114+
[funding]: https://opencollective.com/django-rest-framework

docs/community/3.12-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ continued development by **[signing up for a paid plan][funding]**.
178178
*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), [Lights On Software](https://lightsonsoftware.com), and [Retool](https://retool.com/?utm_source=djangorest&utm_medium=sponsorship).*
179179

180180
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
181-
[funding]: funding.md
181+
[funding]: https://opencollective.com/django-rest-framework

docs/community/3.4-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ The full set of itemized release notes [are available here][release-notes].
177177

178178
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
179179
[moss]: mozilla-grant.md
180-
[funding]: funding.md
180+
[funding]: https://opencollective.com/django-rest-framework
181181
[core-api]: https://www.coreapi.org/
182182
[command-line-client]: https://github.com/encode/django-rest-framework/blob/3.4.7/docs/topics/api-clients.md#command-line-client
183183
[client-library]: https://github.com/encode/django-rest-framework/blob/3.4.7/docs/topics/api-clients.md#python-client-library

docs/community/3.5-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ in version 3.3 and raised a deprecation warning in 3.4. Its usage is now mandato
251251
---
252252

253253
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
254-
[funding]: funding.md
254+
[funding]: https://opencollective.com/django-rest-framework
255255
[uploads]: https://core-api.github.io/python-client/api-guide/utils/#file
256256
[downloads]: https://core-api.github.io/python-client/api-guide/codecs/#downloadcodec
257257
[schema-generation-api]: ../api-guide/schemas.md#schemagenerator

docs/community/3.6-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Once work on those refinements is complete, we'll be starting feature work
193193
on realtime support, for the 3.7 release.
194194

195195
[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
196-
[funding]: funding.md
196+
[funding]: https://opencollective.com/django-rest-framework
197197
[api-docs]: ../topics/documenting-your-api.md
198198
[js-docs]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md#javascript-client-library
199199
[py-docs]: https://github.com/encode/django-rest-framework/blob/3.14.0/docs/topics/api-clients.md#python-client-library

docs/community/3.7-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,6 @@ We're still planning to work on improving real-time support for REST framework b
125125

126126
This will likely be timed so that any REST framework development here ties in with similar work on [API Star][api-star].
127127

128-
[funding]: funding.md
128+
[funding]: https://opencollective.com/django-rest-framework
129129
[schema-docs]: ../api-guide/schemas.md
130130
[api-star]: https://github.com/encode/apistar

docs/community/3.8-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ We're currently working towards moving to using [OpenAPI][openapi] as our defaul
9191

9292
We're doing some consolidation in order to make this happen. It's planned that 3.9 will drop the `coreapi` and `coreschema` libraries, and instead use `apistar` for the API documentation generation, schema generation, and API client libraries.
9393

94-
[funding]: funding.md
94+
[funding]: https://opencollective.com/django-rest-framework
9595
[gh5886]: https://github.com/encode/django-rest-framework/issues/5886
9696
[gh5705]: https://github.com/encode/django-rest-framework/issues/5705
9797
[openapi]: https://www.openapis.org/

docs/community/3.9-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ web framework, which is building a foundational set of tooling for working with
203203
ASGI.
204204

205205

206-
[funding]: funding.md
206+
[funding]: https://opencollective.com/django-rest-framework
207207
[gh5886]: https://github.com/encode/django-rest-framework/issues/5886
208208
[gh5705]: https://github.com/encode/django-rest-framework/issues/5705
209209
[openapi]: https://www.openapis.org/

0 commit comments

Comments
 (0)