diff options
| author | Georg Brandl <georg@python.org> | 2014-03-02 08:50:10 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-03-02 08:50:10 +0100 |
| commit | 9337daca276efcc1c58058a10fffef8b356c7b58 (patch) | |
| tree | 49f519acf9c000d0fa4deefc94f7ac45498f7ac0 /doc/extdev | |
| parent | 30799b02fa7b5c4c4269775b90bd59de4d46f802 (diff) | |
| parent | 4bf6795898b5156073cd243965b5a03c3b6c0536 (diff) | |
| download | sphinx-9337daca276efcc1c58058a10fffef8b356c7b58.tar.gz | |
merge with stable
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/appapi.rst | 11 |
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`). |
