Navigation
index
next
|
previous
|
Tuto Documentation 0.1.0 documentation
»
Documentation generators
»
Sphinx
»
reStructuredText Sphinx documentation
»
Previous topic
exclude_patterns
Next topic
sphinx inline markup
This Page
Show Source
Quick search
sphinx markup
¶
See also
http://sphinx-doc.org/latest/markup/index.html
sphinx inline markup
abbr
doc
Introduction
Example 1 : local link
Example 2 : with explicit link text
Example 3 no explicit link text
command
download
glossary
guilabel
Example 1
Example 2 ampersand accelerators
menuselection
Introduction
Example 1
Example 2 ampersand accelerators
program
Example
term (very important)
sphinx misc markup (very important)
index (very important)
! exclamation (important)
only : including content based on tags
Description
Example1
in conf.py
In a .rst file
pair (very important)
see
seealso
single
triple
Deprecated : module, keyword, operator, object, exception, statement, builtin
sphinx paragraph level markup
contents (très important)
Table-of-contents markup
Example 1
Example 2
deprecated
hlist
note
versionadded
versionchanged
warning
Navigation
index
next
|
previous
|
Tuto Documentation 0.1.0 documentation
»
Documentation generators
»
Sphinx
»
reStructuredText Sphinx documentation
»