diff options
| author | Georg Brandl <georg@python.org> | 2009-03-05 09:48:55 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-03-05 09:48:55 +0100 |
| commit | 9051b533459712afdd770992bc6935d09c7c0a6d (patch) | |
| tree | b8c5d98c350056573c3c5ba9621040a09f82a273 /doc/markup/inline.rst | |
| parent | 1ea50bf165f0456df9d2181c366aecca73e96118 (diff) | |
| download | sphinx-9051b533459712afdd770992bc6935d09c7c0a6d.tar.gz | |
#114: Added an ``abbr`` role to markup abbreviations and acronyms.
Diffstat (limited to 'doc/markup/inline.rst')
| -rw-r--r-- | doc/markup/inline.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index 97b20da7..69721b32 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -278,6 +278,16 @@ Other semantic markup The following roles don't do anything special except formatting the text in a different style: +.. role:: abbr + + An abbreviation. If the role content contains a parenthesized explanation, + it will be treated specially: it will be shown in a tool-tip in HTML, and + output only once in LaTeX. + + Example: ``:abbr:`LIFO (last-in, first-out)```. + + .. versionadded:: 0.6 + .. role:: command The name of an OS-level command, such as ``rm``. |