summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-03-01 08:18:23 +0100
committerGeorg Brandl <georg@python.org>2014-03-01 08:18:23 +0100
commit2f950d546d7304e7b9d6592d27b47f82b3a424ad (patch)
tree54b9419c78a5f725508241c48a1ca731ee9317fa /doc/extdev
parent3c649bfde0126d72894989506c40bb8ae35d7d23 (diff)
parent4047fe8184c2984241b92754b6e6d6b639b8d09b (diff)
downloadsphinx-2f950d546d7304e7b9d6592d27b47f82b3a424ad.tar.gz
Update copyright year.
Diffstat (limited to 'doc/extdev')
-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..88fd4340 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`).