sphinx.ext.intersphinx

module documentation

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.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Variable	`logger`	Undocumented
Class	`IntersphinxDispatcher`	Custom dispatcher for external role.
Class	`IntersphinxRole`	Undocumented
Class	`IntersphinxRoleResolver`	pending_xref node resolver for intersphinx role.
Class	`InventoryAdapter`	Inventory adapter for environment
Function	`_create_element_from_result`	Undocumented
Function	`_get_safe_url`	Gets version of url with basic auth passwords obscured. This function returns results suitable for printing and logging.
Function	`_read_from_url`	Reads data from url with an HTTP GET.
Function	`_resolve_reference`	Undocumented
Function	`_resolve_reference_in_domain`	Undocumented
Function	`_resolve_reference_in_domain_by_target`	Undocumented
Function	`_strip_basic_auth`	Returns url with basic auth credentials removed. Also returns the basic auth username and password if they're present in url.
Function	`fetch_inventory`	Fetch, parse and return an intersphinx inventory file.
Function	`fetch_inventory_group`	Undocumented
Function	`inspect_main`	Debug functionality to print out an inventory
Function	`install_dispatcher`	Enable IntersphinxDispatcher.
Function	`inventory_exists`	Undocumented
Function	`load_mappings`	Load all intersphinx mappings into the environment.
Function	`missing_reference`	Attempt to resolve a missing reference via intersphinx references.
Function	`normalize_intersphinx_mapping`	Undocumented
Function	`resolve_reference_any_inventory`	Attempt to resolve a missing reference via intersphinx references.
Function	`resolve_reference_detect_inventory`	Attempt to resolve a missing reference via intersphinx references.
Function	`resolve_reference_in_inventory`	Attempt to resolve a missing reference via intersphinx references.
Function	`setup`	Undocumented

logger =

Undocumented

def _create_element_from_result(domain, inv_name, data, node, contnode):

Undocumented

Parameters
domain:`Domain`	Undocumented
inv_name:`Optional[str]`	Undocumented
data:`InventoryItem`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Element`	Undocumented

def _get_safe_url(url):

Gets version of url with basic auth passwords obscured. This function returns results suitable for printing and logging.

E.g.: https://user:12345@example.com => https://user@example.com

Parameters
url:`str`	a url
Returns
`str`	url with password removed

def _read_from_url(url, config=None):

Reads data from url with an HTTP GET.

This function supports fetching from resources which use basic HTTP auth as laid out by RFC1738 § 3.1. See § 5 for grammar definitions for URLs.

Parameters
url:`str`	URL of an HTTP resource
config:`Config`	Undocumented
Returns
`file`-like object	data read from resource described by url

def _resolve_reference(env, inv_name, inventory, honor_disabled_refs, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
inv_name:`Optional[str]`	Undocumented
inventory:`Inventory`	Undocumented
honor_disabled_refs:`bool`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_reference_in_domain(env, inv_name, inventory, honor_disabled_refs, domain, objtypes, node, contnode):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
inv_name:`Optional[str]`	Undocumented
inventory:`Inventory`	Undocumented
honor_disabled_refs:`bool`	Undocumented
domain:`Domain`	Undocumented
objtypes:`List[str]`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _resolve_reference_in_domain_by_target(inv_name, inventory, domain, objtypes, target, node, contnode):

Undocumented

Parameters
inv_name:`Optional[str]`	Undocumented
inventory:`Inventory`	Undocumented
domain:`Domain`	Undocumented
objtypes:`List[str]`	Undocumented
target:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def _strip_basic_auth(url):

Returns url with basic auth credentials removed. Also returns the basic auth username and password if they're present in url.

E.g.: https://user:pass@example.com => https://example.com

url need not include basic auth credentials.

Parameters
url:`str`	url which may or may not contain basic auth credentials
Returns
`str`	url with any basic auth creds removed

def fetch_inventory(app, uri, inv):

Fetch, parse and return an intersphinx inventory file.

Parameters
app:`Sphinx`	Undocumented
uri:`str`	Undocumented
inv:`Any`	Undocumented
Returns
`Any`	Undocumented

def fetch_inventory_group(name, uri, invs, cache, app, now):

Undocumented

Parameters
name:`str`	Undocumented
uri:`str`	Undocumented
invs:`Any`	Undocumented
cache:`Any`	Undocumented
app:`Any`	Undocumented
now:`float`	Undocumented
Returns
`bool`	Undocumented

def inspect_main(argv):

Debug functionality to print out an inventory

Parameters
argv:`List[str]`	Undocumented

def install_dispatcher(app, docname, source):

Enable IntersphinxDispatcher.

Note

The installed dispatcher will uninstalled on disabling sphinx_domain automatically.

Parameters
app:`Sphinx`	Undocumented
docname:`str`	Undocumented
source:`List[str]`	Undocumented

def inventory_exists(env, inv_name):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented
inv_name:`str`	Undocumented
Returns
`bool`	Undocumented

def load_mappings(app):

Load all intersphinx mappings into the environment.

Parameters
app:`Sphinx`	Undocumented

def missing_reference(app, env, node, contnode):

Attempt to resolve a missing reference via intersphinx references.

Parameters
app:`Sphinx`	Undocumented
env:`BuildEnvironment`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def normalize_intersphinx_mapping(app, config):

Undocumented

Parameters
app:`Sphinx`	Undocumented
config:`Config`	Undocumented

def resolve_reference_any_inventory(env, honor_disabled_refs, node, contnode):

Attempt to resolve a missing reference via intersphinx references.

Resolution is tried with the target as is in any inventory.

Parameters
env:`BuildEnvironment`	Undocumented
honor_disabled_refs:`bool`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def resolve_reference_detect_inventory(env, node, contnode):

Attempt to resolve a missing reference via intersphinx references.

Resolution is tried first with the target as is in any inventory. If this does not succeed, then the target is split by the first :, to form inv_name:newtarget. If inv_name is a named inventory, then resolution is tried in that inventory with the new target.

Parameters
env:`BuildEnvironment`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def resolve_reference_in_inventory(env, inv_name, node, contnode):

Attempt to resolve a missing reference via intersphinx references.

Resolution is tried in the given inventory with the target as is.

Requires inventory_exists(env, inv_name).

Parameters
env:`BuildEnvironment`	Undocumented
inv_name:`str`	Undocumented
node:`pending_xref`	Undocumented
contnode:`TextElement`	Undocumented
Returns
`Optional[Element]`	Undocumented

def setup(app):

Undocumented

Parameters
app:`Sphinx`	Undocumented
Returns
`Dict[str, Any]`	Undocumented