diff options
Diffstat (limited to 'Doc/documenting/markup.rst')
| -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: |