Documatt
Snippets
reStructuredText
Tech writer blog
reStructuredText and Sphinx Reference
Hello
reStructuredText and Sphinx Reference
Example based gentle reference of the reStructuredText and
Sphinx
syntax, directives, roles and common issues. It demonstrates almost all the markup making it also good for testing Sphinx themes. Free and
open-source
.
Follow us
Table of Contents
Intro
reStructuredText overview
Directives and roles
Sphinx and Docutils
Tools and editors
Collections
Admonitions
Body elements
Code examples
Images
Inline elements
Lists
Document parts
Semantic elements
Sphinx additions
Elements
admonition
attention
caution
code-block
contents
danger
emphasis
enumerated-list
error
figure
file
hint
image
important
inline image
inline literal
literal-block
note
paragraph
parsed-literal-block
rubric
section
seealso
sidebar
strong emphasis
subscript
substitution
superscript
tip
toctree
topic
transition
warning
Etc.
Contributing
Hello
¶
How are you
¶
It’s a beautiful day
¶
Even it’s Monday
¶
Tweet
On this page
Hello
How are you
It’s a beautiful day
Even it’s Monday