IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Mention standard rst roles in inline markup.

Browse Source
This commit is contained in:
Georg Brandl 2010-03-01 15:01:46 +01:00
parent 27d6120528
commit 4f2523d17f
3 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/conf.py
View File

@ -50,6 +50,8 @@ autodoc_member_order = 'groupwise'
todo_include_todos = True todo_include_todos = True
extlinks = {'rstref': ('http://docutils.sourceforge.net/docs/ref/rst/' extlinks = {'rstref': ('http://docutils.sourceforge.net/docs/ref/rst/'
'restructuredtext.html#%s', ''), 'restructuredtext.html#%s', ''),
'rstrole': ('http://docutils.sourceforge.net/docs/ref/rst/'
'roles.html#%s', ''),
'rstdir': ('http://docutils.sourceforge.net/docs/ref/rst/' 'rstdir': ('http://docutils.sourceforge.net/docs/ref/rst/'
'directives.html#%s', '')} 'directives.html#%s', '')}

2
doc/markup/inline.rst
View File

@ -1,5 +1,7 @@
.. highlight:: rest .. highlight:: rest
.. _inline-markup:
Inline markup Inline markup
============= =============

12
doc/rest.rst
View File

@ -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 provide semantic markup and cross-referencing of identifiers, as described in
the appropriate section. The general syntax is ``:rolename:`content```. 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 Lists and Quote-like blocks
--------------------------- ---------------------------