Check links only on master (#1049)

facebookresearch · Feb 15, 2021 · a78aee3 · a78aee3
1 parent d9eabd2
commit a78aee3
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -131,12 +131,26 @@ jobs:
             . venv/bin/activate
             cd docs/
             make html
-            make linkcheck
 
       - persist_to_workspace:
           root: docs/_build
           paths: html
 
+  docs-links:
+    executor: ubuntu-python37
+
+    steps:
+
+      - ubuntu_restore_all
+
+      - run:
+          name: "Check links"
+          when: always
+          command: |
+            . venv/bin/activate
+            cd docs/
+            make linkcheck
+
   static:
     executor: ubuntu-python37
 
@@ -310,6 +324,12 @@ workflows:
               only: master
             tags:
               only: /(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(\.post(0|[1-9][0-9]*))?/
+      - docs-links:  # a bit noisy, so only running on master, and does not stop deployments
+          requires:
+            - install
+          filters:
+            branches:
+              only: master
       - pypi-deploy:
           requires:
             - install

diff --git a/docs/conf.py b/docs/conf.py
@@ -77,5 +77,6 @@
     "windows.html",
     "https://ieeexplore.ieee.org/*",
     "https://iohprofiler.liacs.nl/",  # server error: bad gateway
+    "https://www.facebook.com/whitehat/",  # server error: 500
     r"https://arxiv.org/abs/*",
 ]  # Transient certificate error :(