Skip to content

Sphinx docs monitoring

Draft. This outline will be expanded with verified, platform-specific detail.

How Sphinx sites typically break

  • Toctree membership decides reachability; documents outside any toctree become orphans (Sphinx warns). TODO(verify): warning text
  • Section ids are generated from section titles; renamed sections break #fragment links unless explicit labels are used.
  • Read the Docs serves language and version prefixes such as /en/latest/ and /en/1.4/. TODO(verify)

What Sphinx catches, and what it misses

  • sphinx-build -b linkcheck checks external links on demand. TODO(verify): scope and anchor handling
  • Misses live-site drift, redirects, sitemap drift and cross-version canonicals.

Setting up redirects on Sphinx / Read the Docs

  • Read the Docs redirect rules in the project dashboard; sphinx-reredirects for self-hosted builds. TODO(verify)

How PathIntact monitors a Sphinx site

  • Detection via _static/doctools.js and theme class names TODO(verify); static reading; /{lang}/{version}/ versioning pattern.

Check a Sphinx site now

Free 50-page crawl with broken links, anchors, orphans and sitemap problems.

Free tools

Guides

    Last updated 2026-09-16. Sphinx is a trademark of its owner; PathIntact is not affiliated.