SPHINX-LINKLINT(1)

📦 version 2.0.1, in ubuntu stonking

💖 NAME 💖

okay so bestie, sphinx-linklint — that's the whole vibe of this page — it's the little tool that goes through your Sphinx documents and ✨ checks for excessive references ✨. That's it. That's the job. No cap.

🎀 SYNOPSIS 🎀

Like, here's how you actually call her:

sphinx-linklint [--check CHECK [ , ... ] ] [--fix] INPUTFILE [...]

and if you just need a lil help:

sphinx-linklint --help

🦋 DESCRIPTION 🦋

okay so the way that sphinx-linklint works is: it goes through your Sphinx source documents — those are your INPUTFILEs, one or as many as you feel like handing over — and it finds excessive references. It reports them. And if you want, it will even remove them for you. Find, report, optionally yeet. That's the whole arc. 👑

✨ OPTIONS ✨

  • --check CHECK [ , ... ] — do only the checks you name here, nothing else. Default? All of them, obviously. Here are the CHECK values she speaks:
    • self — finds references that link back to their own section. Like, imagine describing a class and then hitting :class: pointing at itself?? ma'am that's a link to nowhere new. These should not be links, periodt — they literally do not take you anyplace you aren't already standing.
    • paradup — finds multiple identical references inside one single paragraph. The first one should be a link, sure, but the ones after it? They don't need to be links bestie, they're just distractions. 🙈
    • all — do every single one of the above checks. All of them. Chef's kiss.
  • --fix — edits each INPUTFILE in place, correcting whatever references the checks in CHECK turned up. Default behaviour is to not touch any INPUTFILE at all — so if you don't ask, she won't rewrite your files, no worries. 💅
  • --help — shows you the help info, then exits. Iconic, quick, no notes.

😭 REPORTING BUGS 😭

found a bug? not the vibe. Please report any bugs using the sphinx-linklint project issue tracker. 🫶

This manual page is Copyright © 2026 Ben Finney, and is freely available to anyone under certain conditions. See the source document for details. (Yes, certain conditions — go read the source doc, iykyk.)

🌈 SEE ALSO 🌈

  • The sphinx-linklint project upstream home page. Go say hi. 🧚

and that's the page, bestie!! 🎀 it's giving version sphinx-linklint, dated 2026-08-04, and it lives in the General Commands Manual section, if you were wondering where to find her. slay, go link-lint something. 👑✨💖

📦 where this page comes from