summaryrefslogtreecommitdiff
path: root/doc/tutorial.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-01-10 14:55:25 +0100
committerGeorg Brandl <georg@python.org>2014-01-10 14:55:25 +0100
commitbae7682bad8beb658d1b19ee98f2d6c8b10352ab (patch)
treeb41da39c067cf1febba8faafb8738e4233fa4d1f /doc/tutorial.rst
parent5644f4bf70029c9832df6d3394cccc67a7f0f4b2 (diff)
parentbcff26c6dacbd2642517e43a80cdfeddd011aa6e (diff)
downloadsphinx-git-bae7682bad8beb658d1b19ee98f2d6c8b10352ab.tar.gz
merge with intersphinx tutorial section
Diffstat (limited to 'doc/tutorial.rst')
-rw-r--r--doc/tutorial.rst31
1 files changed, 30 insertions, 1 deletions
diff --git a/doc/tutorial.rst b/doc/tutorial.rst
index 9fea11dbe..8e949d4c5 100644
--- a/doc/tutorial.rst
+++ b/doc/tutorial.rst
@@ -248,11 +248,40 @@ Therefore, you must add the appropriate path to :py:data:`sys.path` in your
|more| See :mod:`sphinx.ext.autodoc` for the complete description of the
features of autodoc.
+Intersphinx
+-----------
+
+Many Sphinx documents including the `Python documentation`_ are published on the
+internet. When you want to make links to such documents from your
+documentation, you can do it with :mod:`sphinx.ext.intersphinx`.
+
+.. _Python documentation: http://docs.python.org/3
+
+In order to use intersphinx, you need to activate it in :file:`conf.py` by
+putting the string ``'sphinx.ext.intersphinx'`` into the :confval:`extensions`
+list and set up the :confval:`intersphinx_mapping` config value.
+
+For example, to link to ``io.open()`` in the Python library manual, you need to
+setup your :confval:`intersphinx_mapping` like::
+
+ intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
+
+And now, you can write a cross-reference like ``:py:func:`io.open```. Any
+cross-reference that has no matching target in the current documentation set,
+will be looked up in the documentation sets configured in
+:confval:`intersphinx_mapping` (this needs access to the URL in order to
+download the list of valid targets). Intersphinx also works for some other
+:ref:`domains' <domains>` roles including ``:ref:``, however it doesn't work for
+``:doc:`` as that is non-domain role.
+
+|more| See :mod:`sphinx.ext.intersphinx` for the complete description of the
+features of intersphinx.
+
More topics to be covered
-------------------------
-- Other extensions (math, intersphinx, viewcode, doctest)
+- Other extensions (math, viewcode, doctest)
- Static files
- Selecting a theme
- Templating