3. 段落级标记

3.1. 行内标记

段落包含文本，并且可能包含行内标记：强调、强强调、inline literals、独立超链接 (https://pythonlang.cn)、外部链接 (Python [5])、内部交叉引用 (示例)、包含嵌入式 URI 的外部链接 (Python 网站)、脚注引用（手动编号 [1]、匿名自动编号 [3]、标记自动编号 [2] 或符号 [*])、引用引用 ([12])、替换引用 (EXAMPLE) 和 行内超链接目标（请参阅下面的 目标 以获取返回此处的参考）。字符级行内标记也可以实现（尽管非常丑陋！）在 reStructuredText 中。问题由 |problematic| 文本指示（由处理错误生成；此问题是故意的）。

另外，使用 sphinx.ext.autodoc（我在演示中使用），我可以链接到 test_py_module.test.Foo。它将直接链接到我的代码文档。

解释文本的默认角色为 标题引用。以下是一些显式解释文本角色：PEP 引用 (PEP 287)；RFC 引用 (RFC 2822)；下标；上标；以及 标准 行内 标记 的显式角色。

GUI 标签是指示用户需要执行 某些操作 的一种有用方法。GUI 标签不应超过 line-height，以免 干扰 相邻行的文本。

键绑定指示 [1] 读取操作需要按下键盘或鼠标上的按钮，例如 MMB 和 Shift-MMB。另一个指示用户操作的有用标记是使用 menuselection，这 [1] 可以 [1] 被 [1] 用于 [1] 显示 [1] 软件中的简短和长菜单。例如，menuselection 可以在这里看到，它太长而无法容纳在这行上。 我的 ‣ 软件 ‣ 某个菜单 ‣ 某个子菜单 1 ‣ 子菜单 2。

让我们测试行内字面量中的换行和空白字符的意义：This is an example of --inline-literal --text, --including some-- strangely--hyphenated-words.  Adjust-the-width-of-your-browser-window to see how the text is wrapped.  -- ---- --------  Now note    the spacing    between the    words of    this sentence    (words should    be grouped    in pairs).

如果提供了 --pep-references 选项，则此处应有一个到 PEP 258 的实时链接。

非常长的 URL 应进行换行，以免行溢出并导致水平滚动：https://www.google.com/search?hl=en&q=very%20long%20url%20example%20of%20a%20url%20that%20is%20extremely%20long%20you%20probably%20want%20to%20avoid%20it%20but%20here%20we%20are

3.2. 数学公式

这是一个测试。这是一个方程式：\(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\)。这是另一个

(1)\[\nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]

您可以添加指向上述方程式 (1) 的链接，方法是使用 :eq:。

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-3.0.1.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. 引用

[Citation]

这是我做的引用，让我们把它弄得很长，这样我们就可以看出它不遵循正常的响应式表格内容。

这是对上述内容的引用， [Citation]，以及一个[nonexistent]引用。

3.6.3. 词汇表

这是一个词汇表，其中包含诸如 写作之类的术语的定义

文档

为用户提供使用某物所需的知识。

阅读

通过使用眼睛将信息输入大脑的过程。

写作

将思想放入媒介中以供他人阅读的过程。

3.6.4. 目标

此段落由显式“示例”目标指向。可以在上面的内联标记下找到参考。内联超链接目标也是可能的。

章节标题是隐式目标，按名称引用。请参阅目标，它是参考文献的子部分。

显式外部目标被插入到诸如“Python [5]”之类的引用中。

目标可以是间接的和匿名的。因此此短语也可以指代目标部分。

这是一个`没有目标的超链接引用`_，它会生成错误。

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. 图像

一个图像指令（也可以点击 – 一个超链接引用）

../_images/yi_jing_01_chien.jpg

3.7.3.2. 图形

reStructuredText, the markup syntax

图形是带有标题和/或图例的图像：

re

修订版，重新审视，基于“re”模块。

结构化

结构增强文本，结构化文本。

文本

它确实是，不是吗？

此段落也是图例的一部分。

带有居中对齐的图形指令

../_images/yi_jing_01_chien.jpg

此标题应居中。

3.7.4. 告诫

注意

大体上的指令。

警告

不要拿任何木头镍币。

危险

疯狂的科学家在工作！

错误

无法计算。

提示

它比面包箱大。

重要

  • 洗洗你的耳朵后面。

  • 收拾你的房间。

    • 包括壁橱。

    • 浴室也要。

      • 把浴室里的垃圾扔掉。

      • 清洁水槽。

  • 打电话给你的母亲。

  • 备份你的数据。

注意

这是一个注释。注释中的方程式： \(G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})\)。

建议

如果服务良好，则付15%。

示例

事项1

事项2

事项3

警告

强烈的散文可能会引起极度的心理负担。强烈建议读者谨慎阅读。

顺便说一句……

你也可以自己创建告诫。

3.7.5. 主题、侧边栏和题注

这是一个题注

3.7.6. 目标脚注

3.7.7. 替换文本

我建议您尝试 Python，最棒的语言 [5]。

3.7.8. 复合段落

此段落包含一个文本块

Connecting... OK
Transmitting data... OK
Disconnecting... OK

因此由一个简单段落、一个文本块和另一个简单段落组成。尽管如此，它在语义上是一个段落。

此结构称为复合段落，可以使用“compound”指令生成。