Cross-references between Sage and other projects

This extension configures intersphinx for the documentation of the projects that Sage refers to, and resolves the references that Sphinx alone cannot, either because the target is documented under a public name other than the one that the reference names, or because it has no target to link to.

sage_docbuild.ext.crossrefs.call_intersphinx(app, env, node, contnode)

Call intersphinx and make links between Sage manuals relative.

sage_docbuild.ext.crossrefs.debug_inf(app, message)

sage_docbuild.ext.crossrefs.find_sage_dangling_links(app, env, node, contnode)

Try to find dangling link in local module imports or all.py.

sage_docbuild.ext.crossrefs.prefer_python_inventory(app)

Give the Python inventory the last word on the builtins it shares.

Intersphinx merges every inventory into a single one, project by project in the order of the project names, so that the project whose name sorts last silently claims each name that two projects define. Sphinx documents enumerate as a function of its own in the quickstart guide, for one, which is enough to divert every reference to the builtin away from the Python manual.

Only the builtins are taken back, and only in the Python domain: a name that a project legitimately owns keeps its target, be it a glossary term, a document, a label or a function of the C API that the Python manual happens to name too.

sage_docbuild.ext.crossrefs.set_intersphinx_mappings(app, config)

Add precompiled inventory (the objects.inv)

sage_docbuild.ext.crossrefs.setup(app)

Register this extension with Sphinx.