Run linkcheck on doc build.

anntzer · anntzer · commit 7616f8e9579d · 2019-11-11T22:47:04.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -75,14 +75,13 @@ mpl-run: &mpl-install
 
 doc-run: &doc-build
   name: Build documentation
-  command: |
-    make html O=-T
-    rm -r build/html/_sources
-  working_directory: doc
+  command: make -Cdoc html O=-T
 
 doc-bundle-run: &doc-bundle
   name: Bundle sphinx-gallery documentation artifacts
-  command: tar cf doc/build/sphinx-gallery-files.tar.gz doc/api/_as_gen doc/gallery doc/tutorials
+  command: |
+    rm -r doc/build/html/_sources
+    tar cf doc/build/sphinx-gallery-files.tar.gz doc/api/_as_gen doc/gallery doc/tutorials
   when: always
 
 
@@ -159,6 +158,9 @@ jobs:
       - run: *mpl-install
 
       - run: *doc-build
+      - run:
+          name: "linkcheck"
+          command: make -Cdoc linkcheck
 
       - run: *doc-bundle
       - store_artifacts:
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -97,21 +97,7 @@ In both cases step 3 will have to be un-done right after the release.
 
 Finally, make sure that the docs build cleanly ::
 
-  make -Cdoc O=-j$(nproc) html latexpdf
-
-After the docs are built, check that all of the links, internal and external, are still
-valid.  We use ``linkchecker`` for this, which has not been ported to python3 yet.  You will
-need to create a python2 environment with ``requests==2.9.0`` and linkchecker ::
-
-  conda create -p /tmp/lnkchk python=2 requests==2.9.0
-  source activate /tmp/lnkchk
-  pip install linkchecker
-  pushd doc/build/html
-  linkchecker index.html --check-extern
-  popd
-
-Address any issues which may arise.  The internal links are checked on travis, this should only
-flag failed external links.
+  make -Cdoc O=-j$(nproc) html latexpdf linkcheck
 
 .. _release_tag:
 
