Restore linkcheck and modify Makefile to run in the correct directory

canonical · Oct 3, 2024 · 943caa4 · 943caa4
1 parent a5158a8
commit 943caa4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/.github/workflows/documentation-checks.yaml b/.github/workflows/documentation-checks.yaml
@@ -77,6 +77,16 @@ jobs:
           woke-target: woke
           makefile: Makefile
 
+      - name: Link Check
+        id: linkcheck-step
+        if: success() || failure()
+        uses: canonical/documentation-workflows/linkcheck@main
+        with:
+          working-directory: doc/sphinx
+          install-target: install
+          linkcheck-target: ${{ inputs.linkcheck-target }}
+          makefile: Makefile
+
       - if: ${{ failure() && runner.debug }}
         name: Setup upterm session
         uses: mxschmitt/action-tmate@v3

diff --git a/doc/sphinx/Makefile b/doc/sphinx/Makefile
@@ -99,7 +99,7 @@ spelling: html
 	. $(VENV) ; cd ../build_doc/doc/sphinx/; python3 -m pyspelling -c $(SPHINXDIR)/spellingcheck.yaml -j $(shell nproc)
 
 linkcheck: install
-	. $(VENV) ; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+	. $(VENV) ; cd ../build_doc/doc/sphinx/; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
 
 woke: woke-install
 	woke *.rst **/*.rst --exit-1-on-failure \