The Riddle of the Intersphinx: Configuration and Cross-Reference Composition
summary
Explains how to make intersphinx references actually work by parsing objects.inv (zlib compressed), using sphinx.ext.intersphinx mappings, and decoding the domain/role/artifact triples that determine link targets and tooltips. Shows the ambiguity problem with names like max (builtin vs numpy.ndarray.max), how to set the intersphinx tuple (base URL, objects file), and a small URL-walking helper to locate inventories. Demonstrates the approach fixes broken links and suppresses otherwise cryptic warnings when built with nitpicky.
AI-written summary · about
chapters (20)
- 0:00Intro
- 1:20Slides!
- 1:30What's This Talk About?
- 2:27What is Sphinx?
- 5:14What is Intersphinx?
- 5:48The Riddle of the Sphinx
- 6:22The Riddle of the Intersphinx
- 6:50Broken Artifact References
- 8:45Sphinx Namespace Model
- 10:12Syntax of Artifact Cross-References
- 12:07Sphinx Objects (Artifacts) Inventory: objects.inv
- 12:48Finding objects.inv
- 15:26Format of objects.inv
- 16:00Inspecting the objects.inv
- 19:30Broken Fixed Artifact References
- 20:10Roles in the py Domain
- 20:39Intersphinx Installation/Configuration
- 21:31Syntax of intersphinx_mapping Items dict mapping of user-defined project names to 2-tuples
- 23:04Three Key Tasks 1. Configuring intersphinx in contay
- 23:40Links/Attributions
related talks
32mCustomizing Sphinx: Simple, Normal, and Hard
22mStatic Sites with Sphinx and Markdown
45mIntertwingling the Tiddlywiki with Erlang
29mContinuous Documentation: basics and advanced techniques
28mA Retrieval Augmented Generation system to query the scikit-learn documentation
24mOnline Name-Based Navigation for Software Meta-languages
33mInch: How Elixir 1.7 changed the rules for documentation analysis
20mUser Brainpower vs. AI Blind Spots in API Docs