From 4f2523d17fadbef27b3d74b4a823049e17d549b9 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 1 Mar 2010 15:01:46 +0100 Subject: [PATCH] Mention standard rst roles in inline markup. --- doc/conf.py | 2 ++ doc/markup/inline.rst | 2 ++ doc/rest.rst | 12 ++++++++++++ 3 files changed, 16 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 03dac676c..98dc6565b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -50,6 +50,8 @@ autodoc_member_order = 'groupwise' todo_include_todos = True extlinks = {'rstref': ('http://docutils.sourceforge.net/docs/ref/rst/' 'restructuredtext.html#%s', ''), + 'rstrole': ('http://docutils.sourceforge.net/docs/ref/rst/' + 'roles.html#%s', ''), 'rstdir': ('http://docutils.sourceforge.net/docs/ref/rst/' 'directives.html#%s', '')} diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst index 8c0aba3a9..4f98f021a 100644 --- a/doc/markup/inline.rst +++ b/doc/markup/inline.rst @@ -1,5 +1,7 @@ .. highlight:: rest +.. _inline-markup: + Inline markup ============= diff --git a/doc/rest.rst b/doc/rest.rst index 040bfe969..146b627d9 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -53,6 +53,18 @@ enclosed text should be interpreted in a specific way. Sphinx uses this to provide semantic markup and cross-referencing of identifiers, as described in the appropriate section. The general syntax is ``:rolename:`content```. +Standard reST provides the following roles: + +* :rstrole:`emphasis` -- alternate spelling for ``*emphasis*`` +* :rstrole:`strong` -- alternate spelling for ``**strong**`` +* :rstrole:`literal` -- alternate spelling for ````literal```` +* :rstrole:`subscript` -- subscript text +* :rstrole:`superscript` -- superscript text +* :rstrole:`title-reference` -- for titles of books, periodicals, and other + materials + +See :ref:`inline-markup` for roles added by Sphinx. + Lists and Quote-like blocks ---------------------------