#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: Sarah
Type: | Abderemane
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: linkcheck, github, | Triage Stage:
action | Someday/Maybe
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Jacob Walls):
Hey Sarah. Took a look myself. I believe Nick was hoping for changes in
Sphinx to allow regexes like these [https://github.com/sphinx-
doc/sphinx/issues/6525#issuecomment-828730361 like these] with
backreferences, but testing against the latest version of Sphinx, they
aren't supported:
{{{
WARNING: Failed to compile regex in linkcheck_allowed_redirects:
'^https://\\1\\.readthedocs\\.io/[-a-z]+/(?:master|latest|stable)/$'
invalid group reference 1
WARNING: Failed to compile regex in linkcheck_allowed_redirects:
'^https://docs\\.djangoproject\\.com/\\1/\\d+\\.\\d+/' invalid group
reference 1
}}}
However the released Sphinx changes ''would'' allow regexes without the
backreferences. So if we were to get started now with implementing this in
Django, we would, say, in the case of the readthedocs.io links, either
need to use looser regexes (possibly allowing one readthedocs site to
redirect to another readthedocs site, etc) or need to write regexes for
each readthedocs site (ouch?)
I don't have a strong opinion, but I would say the former option (just
remove the backreferences and allow looser matches) seems tolerable. We're
perfectionists who don't mind using imperfect tools, right? :wink: We
could then tighten up the regexes once someone submits a follow-up PR to
Sphinx. A second opinion would be good to get before setting to work,
though.
I think the triage stage is set to Maybe because there might be objections
to running this on CI vs. manually, but that doesn't bear directly on
whether we should get the regexes written to use the new Sphinx feature.
--
Ticket URL: <https://code.djangoproject.com/ticket/32723#comment:6>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.c524fc6a15a17e43c251ec2727a989a5%40djangoproject.com.
