summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-01-20 21:21:33 +0100
committerGeorg Brandl <georg@python.org>2014-01-20 21:21:33 +0100
commit930d996dbe5bcccbb0d86de5940376b70ed7c3db (patch)
treee8936ce5ad95fa2225c42886ec4c1be99c1a5f55 /doc/extdev/appapi.rst
parentd3db46164e65f031aee3f5059b0bfc7cc22bb41e (diff)
parentfb6c6f5bfe4379c6e680a9757c84b7eebc8443d3 (diff)
downloadsphinx-930d996dbe5bcccbb0d86de5940376b70ed7c3db.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 b91f6c72..eca191bb 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`).