diff options
| author | Georg Brandl <georg@python.org> | 2007-08-17 16:54:59 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2007-08-17 16:54:59 (GMT) |
| commit | 6c82b6c5caef9ec064f507df1335adbbdadc6c49 (patch) | |
| tree | 7be10c02c7ac155f7de6fd79cbccfe4c6df52c5d /Doc/documenting | |
| parent | 20b40d3bce51b099763b196e60d574ccd4530e23 (diff) | |
| download | cpython-6c82b6c5caef9ec064f507df1335adbbdadc6c49.zip cpython-6c82b6c5caef9ec064f507df1335adbbdadc6c49.tar.gz cpython-6c82b6c5caef9ec064f507df1335adbbdadc6c49.tar.bz2 | |
Use glossary x-refs, document new ``!`` feature.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index ebf1dec..1bb2185 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -290,6 +290,11 @@ Variable names are an exception, they should be marked simply with ``*var*``. For all other roles, you have to write ``:rolename:`content```. +.. note:: + + For all cross-referencing roles, if you prefix the content with ``!``, no + reference/hyperlink will be created. + The following roles refer to objects in modules and are possibly hyperlinked if a matching identifier is found: |