summaryrefslogtreecommitdiff
path: root/doc/markup/inline.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-05-24 12:57:07 +0200
committerGeorg Brandl <georg@python.org>2010-05-24 12:57:07 +0200
commit0238e830134d4eecbc52bce644f555f2885bbd59 (patch)
treed381671d66895cf8a5dd8a599de9459a3a39763c /doc/markup/inline.rst
parent563d38a4535aadd321ac970c0259158a8835032f (diff)
parent0301dccddaaaf0615e3d8df47a744a437fa5d355 (diff)
downloadsphinx-git-0238e830134d4eecbc52bce644f555f2885bbd59.tar.gz
Merge with http://bitbucket.org/tpowers/sphinx/ (rewriting the external/internal distinction code)
In HTML output, references now get the class ``internal`` if they are internal to the whole project, as opposed to internal to the current page. The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators.
Diffstat (limited to 'doc/markup/inline.rst')
-rw-r--r--doc/markup/inline.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index 558f813d6..a41d43b9d 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -182,6 +182,11 @@ in a different style:
labels, window titles, field names, menu and menu selection names, and even
values in selection lists.
+ .. versionchanged:: 1.0
+ An accelerator key for the GUI label can be included using an ampersand;
+ this will be stripped and displayed underlined in the output (example:
+ ``:guilabel:`&Cancel```). To include a literal ampersand, double it.
+
.. rst:role:: kbd
Mark a sequence of keystrokes. What form the key sequence takes may depend
@@ -227,6 +232,9 @@ in a different style:
ellipsis some operating systems use to indicate that the command opens a
dialog, the indicator should be omitted from the selection name.
+ ``menuselection`` also supports ampersand accelerators just like
+ :rst:role:`guilabel`.
+
.. rst:role:: mimetype
The name of a MIME type, or a component of a MIME type (the major or minor