mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
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.
This commit is contained in:
@@ -200,7 +200,7 @@ General configuration
|
||||
The name of the default :ref:`domain <domains>`. Can also be ``None`` to
|
||||
disable a default domain. The default is ``'py'``. Those objects in other
|
||||
domains (whether the domain name is given explicitly, or selected by a
|
||||
:dir:`default-domain` directive) will have the domain name explicitly
|
||||
:rst:dir:`default-domain` directive) will have the domain name explicitly
|
||||
prepended when named (e.g., when the default domain is C, Python functions
|
||||
will be named "Python function", not just "function").
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -105,6 +105,9 @@ These themes are:
|
||||
doesn't scroll out of view for long body content. This may not work well
|
||||
with all browsers. Defaults to false.
|
||||
|
||||
- **externalrefs** (true or false): Display external links differently from
|
||||
internal links. Defaults to false.
|
||||
|
||||
There are also various color and font options that can change the color scheme
|
||||
without having to write a custom stylesheet:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user