`[intersphinx]`¶

Intersphinx configuration (external Sphinx inventory resolution).

intersphinx.cache_days¶

Type:: integer
Default:: 5

Inventory cache lifetime, in days, mirroring Sphinx’s intersphinx_cache_limit:

> 0 — a cached inventory expires after this many days (then it is revalidated with a conditional request);
0 — always refresh (the freshness test is never satisfied);
negative — never expire (the cache is always considered fresh).

intersphinx.disabled_reftypes¶

Type:: array of strings
Default:: ["std:doc"]

Reference types that are excluded from the automatic (un-qualified) intersphinx fallback, e.g. "std:doc". The "*" (all) and "domain:*" (whole-domain) wildcard forms are supported; "std:ref" (the Sphinx spelling) is accepted as an alias of "std:label". Inventory-qualified targets and explicit :external: roles ignore this list.

intersphinx.offline¶

Type:: boolean
Default:: false

When true, never perform network fetches: serve inventories from the cache (stale is acceptable) or fail soft with a diagnostic. Useful for network-restricted CI with a pre-warmed cache or committed local inventories.

intersphinx.projects¶

Type:: table of tables
Default:: {}

Per-project inventory configurations, keyed by project name. The name is the prefix used by the inv:target and :external+inv: lookups.

Each entry: Per-project intersphinx configuration ([intersphinx.projects.<name>]).

intersphinx.projects.<name>.inventories¶

Type:: array of strings
Default:: []

Optional inventory locations, tried in order (Sphinx parity). Each entry is either a URL (it contains "://") or a filesystem path relative to the ubproject.toml directory. When empty, the single location "<url>/objects.inv" is used.

intersphinx.projects.<name>.url¶

Type:: string

Base URL of the external project’s documentation (required). Generated links are relative to this URL, and it is the key Sphinx requires to be unique across projects.

intersphinx.resolve_self¶

Type:: string
Default:: ""

The name under which this project refers to ITSELF, mirroring Sphinx 8.2’s intersphinx_resolve_self: a reference whose inventory qualifier equals this name — :ref:`<name>:target` or :external+<name>:ref:`target` — resolves LOCALLY (the qualifier is stripped and the local domains are consulted) instead of against an external inventory. Empty (the default) disables the behaviour.

intersphinx.timeout¶

Type:: float
Default:: 30.0

Timeout, in seconds, for each inventory HTTP request.

[intersphinx]¶

`[intersphinx]`¶