Skip to content

Commit c782571

Browse files
committed
MAINT - adding explicit linkcheck command (#1615)
1 parent 3f41fcc commit c782571

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

doc/Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ html-noplot:
3939
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
4040

4141

42+
linkcheck:
43+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
44+
@echo
45+
@echo "Linkcheck finished. Results are in $(BUILDDIR)/linkcheck."
46+
47+
linkcheck-noplot:
48+
$(SPHINXBUILD) -D plot_gallery=0 -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck-noplot
49+
@echo
50+
@echo "Linkcheck (no plot) finished. Results are in $(BUILDDIR)/linkcheck-noplot."
51+
4252
# Catch-all target: route all unknown targets to Sphinx using the new
4353
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
4454
%: Makefile

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,9 @@ python = "~=3.13.0"
184184
build-doc = { cmd = "make html", cwd = "doc" }
185185
build-doc-quick = { cmd = "make html-noplot", cwd = "doc" }
186186
clean-doc = { cmd = "rm -rf _build/ && rm -rf auto_examples/ && rm -rf reference/generated/", cwd = "doc" }
187+
linkcheck = { cmd = "make linkcheck", cwd = "doc" }
188+
linkcheck-quick = { cmd = "make linkcheck-noplot", cwd = "doc" }
189+
187190

188191
[tool.pixi.feature.lint.tasks]
189192
lint = { cmd = "pre-commit install && pre-commit run -v --all-files --show-diff-on-failure" }

0 commit comments

Comments
 (0)