diff options
| author | Benjamin Peterson <benjamin@python.org> | 2009-01-30 03:39:35 (GMT) |
|---|---|---|
| committer | Benjamin Peterson <benjamin@python.org> | 2009-01-30 03:39:35 (GMT) |
| commit | c4bbc8d7dc0992b37855e1e7173bab16b32a752d (patch) | |
| tree | a306c63d3f426c3a529a96d7bbc42a397cdfcca4 /Doc/documenting/markup.rst | |
| parent | 90eaaf623a7143153fd6d1b9f917b394c923a14a (diff) | |
| download | cpython-c4bbc8d7dc0992b37855e1e7173bab16b32a752d.zip cpython-c4bbc8d7dc0992b37855e1e7173bab16b32a752d.tar.gz cpython-c4bbc8d7dc0992b37855e1e7173bab16b32a752d.tar.bz2 | |
Merged revisions 68884,68973,68978,69003,69083,69112-69113 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r68884 | kristjan.jonsson | 2009-01-24 04:52:26 -0600 (Sat, 24 Jan 2009) | 1 line
Add a test for UNC import paths, see issue 3677
........
r68973 | georg.brandl | 2009-01-26 15:29:38 -0600 (Mon, 26 Jan 2009) | 2 lines
Copy over docs on advanced role features from Sphinx docs.
........
r68978 | mark.dickinson | 2009-01-26 15:51:56 -0600 (Mon, 26 Jan 2009) | 3 lines
Issue #5073: Fix occasional failure of bsddb/test/test_lock.py. Thanks
Hirokazu Yamamoto for the patch.
........
r69003 | benjamin.peterson | 2009-01-26 21:07:53 -0600 (Mon, 26 Jan 2009) | 1 line
excellent place to use a set() #5069
........
r69083 | benjamin.peterson | 2009-01-28 21:03:00 -0600 (Wed, 28 Jan 2009) | 1 line
fix download url
........
r69112 | benjamin.peterson | 2009-01-29 20:02:25 -0600 (Thu, 29 Jan 2009) | 1 line
pep8tify conditionals
........
r69113 | benjamin.peterson | 2009-01-29 20:24:39 -0600 (Thu, 29 Jan 2009) | 1 line
make _tkinter._flatten check the result of PySequence_Size for errors #3880
........
Diffstat (limited to 'Doc/documenting/markup.rst')
| -rw-r--r-- | Doc/documenting/markup.rst | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index a919468..9bb5193 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -290,10 +290,22 @@ they should be marked simply with ``*var*``. For all other roles, you have to write ``:rolename:`content```. -.. note:: +There are some additional facilities that make cross-referencing roles more +versatile: + +* You may supply an explicit title and reference target, like in reST direct + hyperlinks: ``:role:`title <target>``` will refer to *target*, but the link + text will be *title*. + +* If you prefix the content with ``!``, no reference/hyperlink will be created. + +* For the Python object roles, if you prefix the content with ``~``, the link + text will only be the last component of the target. For example, + ``:meth:`~Queue.Queue.get``` will refer to ``Queue.Queue.get`` but only + display ``get`` as the link text. - For all cross-referencing roles, if you prefix the content with ``!``, no - reference/hyperlink will be created. + In HTML output, the link's ``title`` attribute (that is e.g. shown as a + tool-tip on mouse-hover) will always be the full target name. The following roles refer to objects in modules and are possibly hyperlinked if a matching identifier is found: |