diff options
Diffstat (limited to 'doc/ext/intersphinx.rst')
| -rw-r--r-- | doc/ext/intersphinx.rst | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/ext/intersphinx.rst b/doc/ext/intersphinx.rst index 7997472a..94047f8e 100644 --- a/doc/ext/intersphinx.rst +++ b/doc/ext/intersphinx.rst @@ -88,7 +88,7 @@ linking: This will download the corresponding :file:`objects.inv` file from the Internet and generate links to the pages under the given URI. The downloaded - inventory is cached in the Sphinx environment, so it must be redownloaded + inventory is cached in the Sphinx environment, so it must be re-downloaded whenever you do a full rebuild. A second example, showing the meaning of a non-``None`` value of the second @@ -99,8 +99,22 @@ linking: This will read the inventory from :file:`python-inv.txt` in the source directory, but still generate links to the pages under - ``http://docs.python.org/3.2``. It is up to you to update the inventory file as - new objects are added to the Python documentation. + ``http://docs.python.org/3.2``. It is up to you to update the inventory file + as new objects are added to the Python documentation. + + **Multiple target for the inventory** + + .. versionadded:: 1.3 + + Alternative files can be specified for each inventory. One can give a + tuple for the second inventory tuple item as shown in the following + example. This will read the inventory iterating through the (second) + tuple items until the first successful fetch. The primary use case for + this to specify mirror sites for server downtime of the primary + inventory:: + + intersphinx_mapping = {'python': ('http://docs.python.org/3.2', + (None, 'python-inv.txt'))} .. confval:: intersphinx_cache_limit |