3. 段落级别标记¶
目录
3.1. 内联标记¶
段落包含文本,并可能包含内联标记:强调、强强调、内联字面量
、独立超链接(https://pythonlang.cn)、外部超链接(Python 5)、内部交叉引用(示例)、带有嵌入 URI 的外部超链接(Python 网站)、脚注引用(手动编号1、匿名自动编号3、带标签自动编号2,或符号*)、引文引用(12)、替换引用()和内联超链接目标(有关此处的回溯,请参阅下面的目标)。字符级内联标记也可能(尽管极其丑陋!)在 re
Structured
Text 中实现。问题由|问题文本|表示(由处理错误生成;此项是故意的)。
此外,使用我在演示中使用的 sphinx.ext.autodoc
,我可以链接到 test_py_module.test.Foo
。它会将您直接链接到我的代码文档。
解释文本的默认角色是 标题引用。以下是一些显式解释文本角色:PEP 引用(PEP 287);RFC 引用(RFC 2822);一个下标;一个上标;以及用于标准内联标记
的显式角色。
GUI 标签是一种有用的方式,表示用户需要执行 某些操作。GUI 标签不应超出 行高
,以免 干扰 相邻行的文本。
按键绑定表示读取者要按下键盘或鼠标上的按钮,例如 MMB 和 Shift-MMB。另一种指示用户操作的有用标记是使用 菜单选择
,这可用于显示软件中的短菜单和长菜单。例如,这里可以看到一个 菜单选择
,它太长而无法容纳在此行。 。
让我们测试一下内联字面量中的换行和空白重要性:这是一个 --内联-字面量 --文本 的例子, --包括一些-- 奇怪地-带连字符的单词。 调整浏览器的窗口宽度 以查看 文本 是如何 换行的。 -- ---- -------- 现在请注意 这个 句子 中单词 的间距 (单词 应该 成对分组)。
如果提供了 --pep-references
选项,这里应该有一个指向 PEP 258 的实时链接。
3.2. 数学¶
这是一个测试。这里有一个方程:\(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\)。这里还有另一个
您可以使用 :eq:
添加到上述方程的链接 (1)。
3.3. 元数据¶
3.4. 块¶
3.4.1. 字面块¶
字面块以“::”在前面段落的末尾(那边 -->
)指示。它们可以缩进
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
或者它们可以不缩进地被引用
>> Great idea!
>
> Why didn't I think of that?
3.4.2. 行块¶
交给你了,乐队领队埃里克!
一、二、一二三四半只蜜蜂,从哲学角度看,必然,事实上,一半不是。但蜜蜂的一半必须是,就其存在而言。你明白吗?但蜜蜂能被称作是或不是一只完整的蜜蜂吗,当蜜蜂的一半不是蜜蜂时,由于某种古老的伤病?歌唱着…
3.4.3. 块引用¶
块引用由缩进的主体元素组成
我的理论,A. Elk。括号小姐,括号。这个理论如下,现在开始。所有雷龙的一端都细,中间厚得多,然后远端又细。这是我的理论,它是我的,属于我,我拥有它,它也是如此。
——安妮·埃尔克(小姐)
3.4.4. Doctest 块¶
>>> 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)
3.4.5. 代码块¶
# parsed-literal test curl -O http://someurl/release-v2.9.0.dev0+dbc061c.tar-gz
{
"windows": [
{
"panes": [
{
"shell_command": [
"echo 'did you know'",
"echo 'you can inline'"
]
},
{
"shell_command": "echo 'single commands'"
},
"echo 'for panes'"
],
"window_name": "long form"
}
],
"session_name": "shorthands"
}
3.4.5.1. 带行号的强调行¶
1def some_function():
2 interesting = False
3 print 'This line is highlighted.'
4 print 'This one is not...'
5 print '...but this one is.'
3.6. 参考文献¶
3.6.1. 脚注¶
3.6.2. 引文¶
- 11
这是我所引用的内容,让我们把它写得非常长,这样我们就可以看出它不遵循正常的响应式表格样式。
- 12(1,2)
此引文包含一些
代码块
,也许还有一些粗体和斜体。哎呀,我们再加一个到元引文的链接 13 吧。- 13
此引文将有两个反向链接。
这是对上文的引用,12,以及一个[不存在的]引用。
这是另一种引文类型:引文
3.6.3. 词汇表¶
这是一个词汇表,其中包含诸如 写作 等术语的定义
3.6.4. 目标¶
此段落由显式“example”目标指向。引用可在上方的内联标记下找到。内联超链接目标也可能存在。
章节标题是隐式目标,按名称引用。请参见目标,它是`主体元素`_的一个小节。
这里有一个`没有目标值的超链接引用`_,它会生成一个错误。
3.7. 指令¶
3.7.1. 内容¶
这些只是许多 reStructuredText 指令中的一个示例。有关其他指令,请参见:http://docutils.sourceforge.net/docs/ref/rst/directives.html。
3.7.2. 居中文字¶
你可以用 .. centered::
创建一个带居中文本的语句
这是居中文字!
3.7.3. 图像和图表¶
3.7.3.1. 图像¶
一个图像指令(也可点击——一个超链接引用)

3.7.3.2. 图¶

图是指带有标题和/或图例的图像:¶
re |
修订版,重访版,基于 're' 模块。 |
结构化 |
结构增强文本,结构化文本。 |
文本 |
嗯,就是这样,不是吗? |
此段落也属于图例的一部分。
一个居中对齐的图指令

此标题应居中。¶
3.7.4. 劝告¶
注意
大范围指令。
注意
不要轻信他人。
危险
疯子科学家正在工作!
错误
无法计算。
提示
它比面包盒大。
重要提示
洗耳恭听。
清理你的房间。
包括衣柜。
浴室也一样。
把垃圾从浴室里拿出来。
清洁水槽。
打电话给你妈妈。
备份你的数据。
注意
这是一条笔记。笔记中的方程:\(G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})\)。
提示
如果服务好,给15%小费。
示例 |
---|
事物1 |
事物2 |
事物3 |
警告
强烈的文字可能引发极度的脑力消耗。读者请自行斟酌。
顺便说一句……
你也可以自己编造忠告。
3.7.6. 目标脚注¶
3.7.7. 替换文本¶
我建议你试试 Python,是 最好的语言 5。
3.7.8. 复合段落¶
此段落包含一个字面块
Connecting... OK
Transmitting data... OK
Disconnecting... OK
因此它由一个简单段落、一个字面块和另一个简单段落组成。尽管如此,它在语义上仍是一个段落。
这种构造称为复合段落,可以通过“compound”指令生成。
3.8. 下载链接¶
这个 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 超长 下载链接 应为 蓝色、 常规粗细 文本, 带有 前导图标, 并且应 自动换行