From bcff26c6dacbd2642517e43a80cdfeddd011aa6e Mon Sep 17 00:00:00 2001 From: Takayuki Shimizukawa Date: Wed, 18 Dec 2013 08:33:37 +0900 Subject: [PATCH] update a Intersphinx tutorial section. refs #1325 --- doc/tutorial.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 2dc69e18a..052317bc0 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -268,7 +268,9 @@ you need to setup your :confval:`intersphinx_mapping` like:: And now, you can write a cross-reference like: ``:py:func:`io.open```. The 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`. +:confval:`intersphinx_mapping`. Intersphinx also works for some other +:ref:`domains ` roles including ``:ref:``, however it doesn't work +for ``:doc:`` that is non-domain role. |more| See :mod:`sphinx.ext.intersphinx` for the complete description of the features of intersphinx.