mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-19 08:11:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Copy over docs on advanced role features from Sphinx docs.

Browse source
This commit is contained in:
Georg Brandl 2009-01-26 21:29:38 +00:00
parent 354cfc1330
commit 0c2430beda
1 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/documenting/markup.rst
View file

@ -290,10 +290,22 @@ they should be marked simply with ``*var*``.
For all other roles, you have to write ``:rolename:`content```. For all other roles, you have to write ``:rolename:`content```.
.. note:: There are some additional facilities that make cross-referencing roles more
versatile:
For all cross-referencing roles, if you prefix the content with ``!``, no * You may supply an explicit title and reference target, like in reST direct
reference/hyperlink will be created. 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.
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 The following roles refer to objects in modules and are possibly hyperlinked if
a matching identifier is found: a matching identifier is found: