Merge pull request #1613 from mathbunnyru/asalikhov/check_ci_links

Check docs links in Github Actions

Author: mathbunnyru

.github/workflows/sphinx.yml

@@ -1,6 +1,9 @@
-name: Build Sphinx Documentation
+name: Build Sphinx Documentation and check links
 
 on:
+  schedule:
+    # Weekly, at 03:00 on Monday UTC time
+    - cron: "0 3 * * 1"
   pull_request:
     paths:
       - ".github/workflows/sphinx.yml"
@@ -43,3 +46,6 @@ jobs:
 
       - name: Build Documentation
         run: make docs
+
+      - name: Check Documentation URLs
+        run: make linkcheck-docs

Makefile

@@ -138,10 +138,10 @@ install-dev-env: ## install libraries required to build images and run tests
 
 
 docs: ## build HTML documentation
-	sphinx-build -W docs/ docs/_build/
+	sphinx-build -W --keep-going --color docs/ docs/_build/
 
 linkcheck-docs: ## check broken links
-	sphinx-build -b linkcheck docs/ docs/_build/
+	sphinx-build -W --keep-going --color -b linkcheck docs/ docs/_build/
 
 install-docs-env: ## install libraries required to build docs
 	@pip install -r requirements-docs.txt

docs/conf.py

@@ -88,3 +88,15 @@
 
 # MyST configuration reference: https://myst-parser.readthedocs.io/en/latest/sphinx/reference.html
 myst_heading_anchors = 3
+
+linkcheck_ignore = [
+    r".*github\.com.*#",  # javascript based anchors
+    r"http://127\.0\.0\.1:49153/.*",  # example
+    r"https://mybinder\.org/v2/gh/.*",  # lots of 500 errors
+]
+
+linkcheck_allowed_redirects = {
+    r"https://results\.pre-commit\.ci/latest/github/jupyter/docker-stacks/master": r"https://results\.pre-commit\.ci/run/github/.*",  # Latest master CI build
+    r"https://github\.com/jupyter/docker-stacks/issues/new.*": r"https://github\.com/login.*",  # Github wants user to be logon to use this features
+    r"https://github\.com/orgs/jupyter/teams/docker-image-maintainers/members": r"https://github\.com/login.*",
+}