sphinx.ext.intersphinx

module documentation
(source)

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.

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 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
Variable logger Undocumented
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*.
def fetch_inventory(app, uri, inv): (source)

Fetch, parse and return an intersphinx inventory file.

Parameters
app:SphinxUndocumented
uri:strUndocumented
inv:AnyUndocumented
Returns
AnyUndocumented
def fetch_inventory_group(name, uri, invs, cache, app, now): (source)

Undocumented

Parameters
name:strUndocumented
uri:strUndocumented
invs:AnyUndocumented
cache:AnyUndocumented
app:AnyUndocumented
now:floatUndocumented
Returns
boolUndocumented
def inspect_main(argv): (source)

Debug functionality to print out an inventory

Parameters
argv:list[str]Undocumented
def install_dispatcher(app, docname, source): (source)

Enable IntersphinxDispatcher. .. note:: The installed dispatcher will be uninstalled on disabling sphinx_domain automatically.

Parameters
app:SphinxUndocumented
docname:strUndocumented
source:list[str]Undocumented
def inventory_exists(env, inv_name): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
inv_name:strUndocumented
Returns
boolUndocumented
def load_mappings(app): (source)

Load all intersphinx mappings into the environment.

Parameters
app:SphinxUndocumented
def missing_reference(app, env, node, contnode): (source)

Attempt to resolve a missing reference via intersphinx references.

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def normalize_intersphinx_mapping(app, config): (source)

Undocumented

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def resolve_reference_any_inventory(env, honor_disabled_refs, node, contnode): (source)

Attempt to resolve a missing reference via intersphinx references. Resolution is tried with the target as is in any inventory.

Parameters
env:BuildEnvironmentUndocumented
honor_disabled_refs:boolUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def resolve_reference_detect_inventory(env, node, contnode): (source)

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:BuildEnvironmentUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def resolve_reference_in_inventory(env, inv_name, node, contnode): (source)

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:BuildEnvironmentUndocumented
inv_name:strUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
logger = (source)

Undocumented

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

Undocumented

Parameters
domain:DomainUndocumented
inv_name:str|NoneUndocumented
data:InventoryItemUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
ElementUndocumented
def _get_safe_url(url): (source)

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 :param url: a url :type url: ``str`` :return: *url* with password removed :rtype: ``str``

Parameters
url:strUndocumented
Returns
strUndocumented
def _read_from_url(url, config=None): (source)

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. .. seealso: https://www.ietf.org/rfc/rfc1738.txt :param url: URL of an HTTP resource :type url: ``str`` :return: data read from resource described by *url* :rtype: ``file``-like object

Parameters
url:strUndocumented
config:Config|NoneUndocumented
Returns
IOUndocumented
def _resolve_reference(env, inv_name, inventory, honor_disabled_refs, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
inv_name:str|NoneUndocumented
inventory:InventoryUndocumented
honor_disabled_refs:boolUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_reference_in_domain(env, inv_name, inventory, honor_disabled_refs, domain, objtypes, node, contnode): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
inv_name:str|NoneUndocumented
inventory:InventoryUndocumented
honor_disabled_refs:boolUndocumented
domain:DomainUndocumented
objtypes:list[str]Undocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def _resolve_reference_in_domain_by_target(inv_name, inventory, domain, objtypes, target, node, contnode): (source)

Undocumented

Parameters
inv_name:str|NoneUndocumented
inventory:InventoryUndocumented
domain:DomainUndocumented
objtypes:list[str]Undocumented
target:strUndocumented
node:pending_xrefUndocumented
contnode:TextElementUndocumented
Returns
Element|NoneUndocumented
def _strip_basic_auth(url): (source)

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. :param url: url which may or may not contain basic auth credentials :type url: ``str`` :return: *url* with any basic auth creds removed :rtype: ``str``

Parameters
url:strUndocumented
Returns
strUndocumented