mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Deprecate legacy `intersphinx_mapping` format (#11247)
This format was made obsolete in Sphinx 1.0, but never formally deprecated.
This commit is contained in:
@@ -63,17 +63,7 @@ linking:
|
||||
When fetching remote inventory files, proxy settings will be read from
|
||||
the ``$HTTP_PROXY`` environment variable.
|
||||
|
||||
**Old format for this config value**
|
||||
|
||||
This is the format used before Sphinx 1.0. It is still recognized.
|
||||
|
||||
A dictionary mapping URIs to either ``None`` or an URI. The keys are the
|
||||
base URI of the foreign Sphinx documentation sets and can be local paths or
|
||||
HTTP URIs. The values indicate where the inventory file can be found: they
|
||||
can be ``None`` (at the same location as the base URI) or another local or
|
||||
HTTP URI.
|
||||
|
||||
**New format for this config value**
|
||||
**Format**
|
||||
|
||||
.. versionadded:: 1.0
|
||||
|
||||
@@ -136,6 +126,28 @@ linking:
|
||||
('../../otherbook/build/html/objects.inv', None)),
|
||||
}
|
||||
|
||||
**Old format for this config value**
|
||||
|
||||
.. deprecated:: 6.2
|
||||
|
||||
.. RemovedInSphinx80Warning
|
||||
|
||||
.. caution:: This is the format used before Sphinx 1.0.
|
||||
It is deprecated and will be removed in Sphinx 8.0.
|
||||
|
||||
A dictionary mapping URIs to either ``None`` or an URI. The keys are the
|
||||
base URI of the foreign Sphinx documentation sets and can be local paths or
|
||||
HTTP URIs. The values indicate where the inventory file can be found: they
|
||||
can be ``None`` (at the same location as the base URI) or another local or
|
||||
HTTP URI.
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
|
||||
intersphinx_mapping = {'https://docs.python.org/': None}
|
||||
|
||||
|
||||
.. confval:: intersphinx_cache_limit
|
||||
|
||||
The maximum number of days to cache remote inventories. The default is
|
||||
|
||||
Reference in New Issue
Block a user