IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#461: elaborate how to use intersphinx.

Browse Source
This commit is contained in:
Georg Brandl 2010-07-10 16:59:23 +02:00
parent d0900e8862
commit 400617e692
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/ext/intersphinx.rst
View File

@ -9,7 +9,21 @@
.. versionadded:: 0.5 .. versionadded:: 0.5
This extension can generate automatic links to the documentation of objects in This extension can generate automatic links to the documentation of objects in
other projects. This works as follows: other projects.
Usage is simple: whenever Sphinx encounters a cross-reference that has no
matching target in the current documentation set, it looks for targets in the
documentation sets configured in :confval:`intersphinx_mapping`. A reference
like ``:py:class:`zipfile.ZipFile``` can then link to the Python documentation
for the ZipFile class, without you having to specify where it is located
exactly.
When using the "new" format (see below), you can even force lookup in a foreign
set by prefixing the link target appropriately. A link like ``:ref:`comparison
manual <python:comparisons>``` will then link to the label "comparisons" in the
doc set "python", if it exists.
Behind the scenes, this works as follows:
* Each Sphinx HTML build creates a file named :file:`objects.inv` that contains * Each Sphinx HTML build creates a file named :file:`objects.inv` that contains
a mapping from object names to URIs relative to the HTML set's root. a mapping from object names to URIs relative to the HTML set's root.