Blocks#
Block Quotes#
Block quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
Epigraph#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#epigraph
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
Pull quotes#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#pull-quote
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
Highlights#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#highlights
My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.
—Anne Elk (Miss)
Line Blocks#
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
This is a normal text paragraph.
This is a normal text paragraph again.
Monospace Blocks#
Sphinx supports many kinds of monospace blocks. This section is meant to showcase all of them that as known to the author of this page, at the time of writing.
Production List#
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-productionlist
This directive is used to enclose a group of productions. Each production is given on a single line and consists of a name, separated by a colon from the following definition.
This just shows up as a vanilla <pre>
, which is… both nice and a bit
annoying.
try_stmt ::= try1_stmt | try2_stmt try1_stmt ::= "try" ":"suite
("except" [expression
[","target
]] ":"suite
)+ ["else" ":"suite
] ["finally" ":"suite
] try2_stmt ::= "try" ":"suite
"finally" ":"suite
"this-is-intentionally-very-stupidly-long-to-make-sure-that-this-has-a-proper-scrollbar"
Literal Blocks#
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks
contains a block of text where line breaks and whitespace are significant and must be preserved
This is a normal text paragraph. The next paragraph is a code sample:
It is not processed in any way, except
that the indentation is removed.
It can span multiple lines.
This is a normal text paragraph again.
They can be quoted without indentation:
>> Great idea!
>
> Why didn't I think of that?
1from typing import Any, Dict, Iterator, List, Optional
2
3import sphinx.application
4from docutils import nodes
5from pygments.formatters import HtmlFormatter
6from pygments.style import Style
7from pygments.token import Text
8from sphinx.builders.html import StandaloneHTMLBuilder
9from sphinx.environment.adapters.toctree import TocTree
10from sphinx.highlighting import PygmentsBridge
11from sphinx.transforms.post_transforms import SphinxPostTransform
Doctest Blocks#
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#doctest-blocks
Doctest blocks are interactive Python sessions cut-and-pasted into docstrings. They are meant to illustrate usage by example, and provide an elegant and powerful testing environment via the doctest module in the Python standard library.
Note
This is fine.
>>> print('Python-specific usage examples; begun with ">>>"')
Python-specific usage examples; begun with ">>>"
>>> print("(cut and pasted from interactive Python sessions)")
(cut and pasted from interactive Python sessions)
>>> print("This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly.")
This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly.
Parsed Literals#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal-block
It is equivalent to a line block with different rendering: typically in a typewriter/monospaced typeface, like an ordinary literal block. Parsed literal blocks are useful for adding hyperlinks to code examples.
# parsed-literal test
curl -O http://someurl/release-0.1.0.tar-gz
echo "This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly."
Code Block#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#code
The “code” directive constructs a literal block [containing code].
This has an alias of code-block
.
1from typing import Iterator
2
3# This is an example
4class Math:
5 @staticmethod
6 def fib(n: int) -> Iterator[int]:
7 """Fibonacci series up to n"""
8 a, b = 0, 1
9 while a < n:
10 yield a
11 a, b = b, a + b
12
13
14result = sum(Math.fib(42))
15print("The answer is {}".format(result))
With line numbers#
1def some_function():
2 interesting = False
3 print("This line is highlighted.")
4 print("This one is not...")
5 print("...but this one is.")
6 print(
7 "This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly."
8 )
With none
highlighting#
# Taken from https://en.wikipedia.org/wiki/Pseudocode#Example
algorithm ford-fulkerson is
input: Graph G with flow capacity c,
source node s,
sink node t
output: Flow f such that f is maximal from s to t
(Note that f(u,v) is the flow from node u to node v, and c(u,v) is the flow capacity from node u to node v)
for each edge (u, v) in GE do
f(u, v) ← 0
f(v, u) ← 0
while there exists a path p from s to t in the residual network Gf do
let cf be the flow capacity of the residual network Gf
cf(p) ← min{cf(u, v) | (u, v) in p}
for each edge (u, v) in p do
f(u, v) ← f(u, v) + cf(p)
f(v, u) ← −f(u, v)
return f