summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-03-25 10:27:36 +0100
committerGeorg Brandl <georg@python.org>2014-03-25 10:27:36 +0100
commit9ff2cc2ce7c09b32058ef64d9f81ff6170117360 (patch)
treeefa63a59bf2f06ca10ca2854012724682a9ecc41 /doc/extdev/appapi.rst
parent9c7b7b98ccd649b54a9576fb658a33d6398e0f60 (diff)
parent01a3c169a06a2f69c6ca93dbee9fd5863af25c7c (diff)
downloadsphinx-9ff2cc2ce7c09b32058ef64d9f81ff6170117360.tar.gz
merge with stable
Diffstat (limited to 'doc/extdev/appapi.rst')
-rw-r--r--doc/extdev/appapi.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 24136f74..48f5d96e 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -212,10 +212,13 @@ package.
.. index:: pair: function; directive
The reference node will be of class ``literal`` (so it will be rendered in a
- proportional font, as appropriate for code) unless you give the *ref_nodeclass*
- argument, which must be a docutils node class (most useful are
- ``docutils.nodes.emphasis`` or ``docutils.nodes.strong`` -- you can also use
- ``docutils.nodes.generated`` if you want no further text decoration).
+ proportional font, as appropriate for code) unless you give the
+ *ref_nodeclass* argument, which must be a docutils node class. Most useful
+ are ``docutils.nodes.emphasis`` or ``docutils.nodes.strong`` -- you can also
+ use ``docutils.nodes.generated`` if you want no further text decoration. If
+ the text should be treated as literal (e.g. no smart quote replacement), but
+ not have typewriter styling, use ``sphinx.addnodes.literal_emphasis`` or
+ ``sphinx.addnodes.literal_strong``.
For the role content, you have the same syntactical possibilities as for
standard Sphinx roles (see :ref:`xref-syntax`).