diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-19 22:58:15 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-19 22:58:15 +0900 |
commit | aa1bc83c2ac9357b39048b555c3fdb0efff3449c (patch) | |
tree | c1149670ca18b5f9820505322d5b0a5832395ea4 /sphinx/ext/intersphinx.py | |
parent | 759a526b12213c59d6ae4c8f66682f4328b764f4 (diff) | |
parent | 017ef6118b4fe588140266ad6ff2393cbddd9137 (diff) | |
download | sphinx-git-aa1bc83c2ac9357b39048b555c3fdb0efff3449c.tar.gz |
Merge branch '4.x'
Diffstat (limited to 'sphinx/ext/intersphinx.py')
-rw-r--r-- | sphinx/ext/intersphinx.py | 31 |
1 files changed, 12 insertions, 19 deletions
diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 35796a88d..a347b02ff 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -1,26 +1,19 @@ -""" - sphinx.ext.intersphinx - ~~~~~~~~~~~~~~~~~~~~~~ - - Insert links to objects documented in remote Sphinx documentation. - - This works as follows: +"""Insert links to objects documented in remote Sphinx documentation. - * 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. +This works as follows: - * 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. +* 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. - * 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. +* 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. - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +* 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. """ import concurrent.futures |