Skip to content

Fix docs links#6418

Merged
snejus merged 5 commits intomasterfrom
fix-docs-links
Mar 7, 2026
Merged

Fix docs links#6418
snejus merged 5 commits intomasterfrom
fix-docs-links

Conversation

@snejus
Copy link
Member

@snejus snejus commented Mar 6, 2026

Documentation Link Maintenance

This PR audits and fixes all hyperlinks across the beets documentation. No functional code changes — purely doc hygiene.

What changed

  • HTTP → HTTPS: Upgrades all http:// links to https:// where supported.
  • Broken/outdated URLs: Replaces dead or redirected links with their current canonical targets. Key examples:
    • codecov.ioapp.codecov.io
    • Python docs from docs.python.org/library/docs.python.org/3/library/
    • PEP links from python.org/dev/peps/peps.python.org/
    • SourceForge project links updated to current project page URLs
    • Spotify, Plex, Sonos, Discogs, IPFS, and other service URLs updated to their current domains/paths
    • Archived URLs wrapped in web.archive.org where the original is gone (e.g. echonest, albumart.org, phash)
  • docs/conf.py: Adds link-check exclusions for domains known to block automated requests (SourceForge, fanart.tv, Imgur, Discogs settings).

Impact

No user-facing behaviour changes. Fixes broken links that would frustrate contributors and users reading the docs, and unblocks the Sphinx linkcheck builder from false positives.

Copilot AI review requested due to automatic review settings March 6, 2026 09:30
@snejus snejus requested a review from a team as a code owner March 6, 2026 09:30
@snejus snejus requested review from JOJ0 and henry-oberholtzer March 6, 2026 09:30
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

grug see PR try make docs link not rot. no code logic change. just docs hygiene so people click link and not cry.

Changes:

  • change many docs URLs to new https + new canonical places
  • add Sphinx linkcheck_ignore for sites that block robots / need login
  • add changelog note about docs URL update

Reviewed changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
docs/reference/query.rst update Python re docs link to /3/ path
docs/reference/pathformat.rst update Python string docs link + MusicBrainz sample link
docs/reference/cli.rst update PyPI rarfile link
docs/plugins/web.rst update nginx + flask doc links
docs/plugins/thumbnails.rst update ImageMagick link
docs/plugins/subsonicupdate.rst upgrade Subsonic links to https
docs/plugins/spotify.rst update Spotify Web API reference links
docs/plugins/sonosupdate.rst update Sonos link
docs/plugins/replaygain.rst update several dependency/tool links (PyGObject, aacgain, mp3gain, etc.)
docs/plugins/plexupdate.rst update Plex token doc link + Plex site link
docs/plugins/musicbrainz.rst update MusicBrainz “building search indexes” link
docs/plugins/lyrics.rst update Google CSE + Sphinx/docutils links
docs/plugins/lastimport.rst update Last.fm link
docs/plugins/lastgenre.rst update Last.fm link + Wikipedia scrape script link
docs/plugins/keyfinder.rst upgrade keyfinder link to https
docs/plugins/ipfs.rst update IPFS + go-ipfs (kubo) links
docs/plugins/info.rst update id3v2 link
docs/plugins/index.rst update many plugin index reference links (deezer/spotify/plex/sonos/subsonic/etc.)
docs/plugins/hook.rst update PEP-3101 link to peps.python.org
docs/plugins/fetchart.rst update Google CSE + ImageMagick links
docs/plugins/embedart.rst update ImageMagick + archive phash link
docs/plugins/discogs.rst update Discogs base link + example album link
docs/plugins/deezer.rst update Deezer base link + example URL
docs/plugins/convert.rst update LAME + HydrogenAudio wiki links
docs/plugins/bpd.rst update several client/protocol links (SourceForge, fandom, mpd docs)
docs/plugins/beatport.rst update Discogs base link
docs/plugins/badfiles.rst update mp3val link
docs/plugins/aura.rst update Flask/uwsgi/proxy-related links
docs/plugins/absubmit.rst update requests docs link to /latest/
docs/guides/installation.rst update Python/pip + distro package links
docs/faq.rst update pastebin + bug-writing guideline + id3v2 + superuser links
docs/dev/plugins/other/logging.rst update PEP-3101 link
docs/dev/plugins/index.rst replace SO shortlink with full question URL
docs/dev/plugins/commands.rst update optparse links to /3/
docs/conf.py add more linkcheck_ignore patterns
docs/changelog.rst add entry about URL updates + refresh many historical reference links
README_kr.rst update Codecov link to app.codecov.io
README.rst update Codecov link to app.codecov.io
CONTRIBUTING.rst update Codecov + PEP + logging/stdtypes links; replace test template link with test-query ref
CODE_OF_CONDUCT.rst adjust Contributor Covenant link (trailing slash)

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 8 comments.

@codecov
Copy link

codecov bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.33%. Comparing base (a6ac5ef) to head (b3f5585).
⚠️ Report is 6 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6418      +/-   ##
==========================================
- Coverage   69.34%   69.33%   -0.01%     
==========================================
  Files         141      141              
  Lines       18443    18443              
  Branches     3019     3019              
==========================================
- Hits        12789    12788       -1     
- Misses       5018     5019       +1     
  Partials      636      636              

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@snejus snejus merged commit cff5434 into master Mar 7, 2026
20 checks passed
@snejus snejus deleted the fix-docs-links branch March 7, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants