3.9. sphinx.ext.intersphinx¶
Insert links to objects documented in remote Sphinx documentation.
This works as follows:
- Each Sphinx HTML build creates a file named “objects.inv” that contains a mapping from object names to URIs relative to the HTML set’s root.
- Projects using the Intersphinx extension can specify links to such mapping files in the intersphinx_mapping config value. The mapping will then be used to resolve otherwise missing references to objects into links to the other documentation.
- By default, the mapping file is assumed to be at the same location as the rest of the documentation; however, the location of the mapping file can also be specified individually, e.g. if the docs should be buildable without Internet access.
| copyright: | Copyright 2007-2016 by the Sphinx team, see AUTHORS. |
|---|---|
| license: | BSD, see LICENSE for details. |
3.9.1. Functions¶
fetch_inventory(app, uri, inv) |
Fetch, parse and return an intersphinx inventory file. |
iteritems(d, **kw) |
Return an iterator over the (key, value) pairs of a dictionary. |
load_mappings(app) |
Load all intersphinx mappings into the environment. |
missing_reference(app, env, node, contnode) |
Attempt to resolve a missing reference via intersphinx references. |
read_inventory_v1(f, uri, join) |
|
read_inventory_v2(f, uri, join[, bufsize]) |
|
relative_path(source, target) |
Build and return a path to target, relative to source (both files). |
setup(app) |