mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Mention standard rst roles in inline markup.
This commit is contained in:
parent
27d6120528
commit
4f2523d17f
@ -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', '')}
|
||||
|
||||
|
@ -1,5 +1,7 @@
|
||||
.. highlight:: rest
|
||||
|
||||
.. _inline-markup:
|
||||
|
||||
Inline markup
|
||||
=============
|
||||
|
||||
|
12
doc/rest.rst
12
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
|
||||
---------------------------
|
||||
|
Loading…
Reference in New Issue
Block a user