Stream: docs

Topic: check links


view this post on Zulip Oliver Bertuch (Sep 26 2024 at 12:24):

At the summer school I learned about sphinx-build -b linkcheck source build that checks all the external links for validity. Sounds like a nice low hanging fruit for the CI pipeline! https://www.sphinx-doc.org/en/master/usage/builders/index.html

view this post on Zulip Philip Durbin ๐Ÿš€ (Sep 26 2024 at 13:24):

Wow, yes, sounds very nice.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jun 06 2026 at 10:51):

@Parth karalkar do you want to try running linkcheck locally to see if you can get it working?

view this post on Zulip Parth karalkar (Jun 08 2026 at 05:56):

Yesss sure

view this post on Zulip Philip Durbin ๐Ÿš€ (Jun 09 2026 at 11:18):

@Oliver Bertuch I gave this a try but I don't understand what's wrong. There's only one "aws-cors":

(venv) pdurbin@mac sphinx-guides % make linkcheck
sphinx-build -b linkcheck -d build/doctrees  -W source build/linkcheck
Running Sphinx v7.4.0
loading translations [en]... done
/Users/pdurbin/github/iqss/guides.dataverse.org/doc/sphinx-guides/venv/lib/python3.13/site-packages/sphinx/builders/linkcheck.py:86: RemovedInSphinx80Warning: The default value for 'linkcheck_report_timeouts_as_broken' will change to False in Sphinx 8, meaning that request timeouts will be reported with a new 'timeout' status, instead of as 'broken'. This is intended to provide more detail as to the failure mode. See https://github.com/sphinx-doc/sphinx/issues/11868 for details.
  warnings.warn(deprecation_msg, RemovedInSphinx80Warning, stacklevel=1)
myst v4.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [linkcheck]: targets for 144 source files that are out of date
updating environment: [new config] 144 added, 0 changed, 0 removed
reading sources... [100%] versions

Warning, treated as error:
/Users/pdurbin/github/iqss/guides.dataverse.org/doc/sphinx-guides/source/installation/big-data-support.rst:100:Duplicate explicit target name: "aws-cors".
make: *** [linkcheck] Error 2
(venv) pdurbin@mac sphinx-guides % ack aws-cors
source/installation/big-data-support.rst
101:        :name: aws-cors
(venv) pdurbin@mac sphinx-guides %

Last updated: Aug 18 2026 at 08:27 UTC