3. 段落级别标记 ¶

3.1. 内联标记 ¶

段落包含文本，并且可能包含内联标记：强调，强烈强调，内联字面量，独立超链接 (https://pythonlang.cn)，外部超链接 (Python 5)，内部交叉引用 (示例)，带有嵌入 URI 的外部超链接 (Python 网站)，脚注引用 (手动编号 1，匿名自动编号 3，标记自动编号 2，或符号 *)，引用引用 (12)，替换引用 ()，以及内联超链接目标 (有关此处的回溯引用，请参阅下文的目标)。字符级内联标记也是可能的 (尽管极其难看!) 在 reStructuredText 中。问题由 |problematic| 文本指示 (由处理错误生成；这是一个故意的错误)。

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

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

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

按键绑定指示读者要按下键盘或鼠标上的按钮，例如 MMB 和 Shift-MMB。指示用户操作的另一个有用标记是使用 menuselection，它可用于显示软件中的短菜单和长菜单。例如，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 的实时链接。

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}\]

您可以通过使用 :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. 行块 ¶

这是一个行块。它以空行结尾。

每个新行都以竖线 (“|”) 开头。

保留换行符和初始缩进。

续行是长行的换行部分；它们以空格代替竖线开头。

续行的左边缘不必与上方文本的左边缘对齐。

这是第二个行块。

内部允许空行，但它们必须以“|”开头。

开始吧，乐队指挥 Eric！

一、二，一、二、三、四

半只蜜蜂，从哲学上讲，

必须，事实上，一半不是。

但半只蜜蜂必须是，

面对面 它的实体。你明白吗？

但是可以说一只蜜蜂是

或不是整只蜜蜂，

当半只蜜蜂不是蜜蜂时，

由于一些古老的伤害？

唱歌…

3.4.3. 块引用 ¶

块引用由缩进的正文元素组成

我的理论，作者是 A. Elk。括号小姐，括号。这个理论如下，现在开始。所有雷龙一端都很细，中间非常非常粗，远端又变细。这就是我的理论，它是我的，属于我，我拥有它，它也是如此。

—Anne 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.7.0.dev0+426562f.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. 带行号的强调行 ¶

def some_function():
    interesting = False
    print 'This line is highlighted.'
    print 'This one is not...'
    print '...but this one is.'

3.5. 侧边栏 ¶

第一卦由六条完整的爻线组成。这些完整的爻线代表原始力量，它是发光的、活跃的、强大的、精神的。这一卦在性格上始终是强大的，因为它没有弱点，所以它的本质是力量或能量。它的意象是天。它的能量被认为不受空间中任何固定条件的限制，因此被理解为运动。时间被认为是这种运动的基础。因此，这一卦也包含了时间的力量和在时间中持续的力量，即持续性。

这一卦所代表的力量要从双重意义上来解释，即它对宇宙的作用和它对人类世界的作用。在与宇宙的关系上，这一卦表达了神灵强大的创造力。在与人类世界的关系上，它表示圣人或贤人，统治者或人类领袖的创造性行动，他们通过自己的力量唤醒和发展人类更高的天性。

3.5.1. 带侧边栏的代码 ¶

文字包含也可以有标题。¶

# -*- coding: utf-8 -*-
"""Test Module for sphinx_rtd_theme."""


class Foo:

    """Docstring for class Foo.

    This text tests for the formatting of docstrings generated from output
    ``sphinx.ext.autodoc``. Which contain reST, but sphinx nests it in the
    ``<dl>``, and ``<dt>`` tags. Also, ``<tt>`` is used for class, method names
    and etc, but those will *always* have the ``.descname`` or
    ``.descclassname`` class.

    Normal ``<tt>`` (like the <tt> I just wrote here) needs to be shown with
    the same style as anything else with ````this type of markup````.

    It's common for programmers to give a code example inside of their
    docstring::

        from test_py_module import Foo

        myclass = Foo()
        myclass.dothismethod('with this argument')
        myclass.flush()

        print(myclass)


    Here is a link to :py:meth:`capitalize`.
    Here is a link to :py:meth:`__init__`.

    """

    #: Doc comment for class attribute Foo.bar.
    #: It can have multiple lines.
    bar = 1

    flox = 1.5   #: Doc comment for Foo.flox. One line only.

3.6. 参考 ¶

3.6.1. 脚注 ¶

1(1,2)

脚注包含正文元素，始终至少缩进 3 个空格。

这是脚注的第二个段落。

2(1,2)

脚注可以编号，可以是手动编号（如 1），也可以使用带有“#”前缀的标签自动编号。此脚注有一个标签，因此可以从多个位置引用它，既可以作为脚注参考 (2) 也可以作为超链接参考 (label)。

3

此脚注使用仅为“#”的标签自动匿名编号。

*

脚注也可以使用符号，用“*”标签指定。这是对下一个脚注的引用：†。

†

此脚注显示序列中的下一个符号。

4

这是一个未被引用的脚注，引用了一个不存在的脚注：[5]_。

3.6.2. 引文 ¶

11: 这是我做的引文，让我们把它做得非常长，这样我们就可以看出它不遵循正常的响应式表格的东西。
12(1,2): 此引文中有一些 代码块，可能还有一些粗体和斜体。见鬼，让我们放一个指向元引文的链接 13。
13: 此引文将有两个反向链接。

这是对上述内容的引用，12，以及一个 [不存在的] 引文。

这是另一种类型的引文：引文

3.6.3. 术语表 ¶

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

文档¶: 为用户提供他们使用某物所需的知识。
阅读¶: 通过使用眼睛将信息摄入大脑的过程。
写作¶: 将想法放入媒介供其他人阅读的过程。

3.6.4. 目标 ¶

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

章节标题是隐式目标，通过名称引用。请参阅目标，它是 `正文元素`_ 的子章节。

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

目标可以是间接的和匿名的。因此，这个短语也可能指目标章节。

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

小心

不要拿任何木镍币。

危险

疯狂的科学家在工作！

错误

无法计算。

提示

它比面包盒还大。

重要

洗耳朵后面。
整理你的房间。
- 包括壁橱。
- 也包括浴室。
  - 把浴室的垃圾拿出去。
  - 清洁水槽。
给你的母亲打电话。
备份你的数据。

注意

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

技巧

如果服务好，给 15% 的小费。

示例
事物 1
事物 2
事物 3

警告

强烈的文字可能会引起极度的脑力劳动。强烈建议读者谨慎。

顺便说一句……

您也可以自定义提示框。

3.7.5. 主题、侧边栏和标题 ¶

主题标题

这是一个主题。

这是一个标题

3.7.6. 目标脚注 ¶

5(1,2,3): https://pythonlang.cn/

3.7.7. 替换文本 ¶

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

3.7.8. 复合段落 ¶

此段落包含一个文字块

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

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

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

3.8. 下载链接 ¶

这个长长长长长长长长长长长长长长长下载链接应该是蓝色，普通粗细文本带有前导图标，并且应该包裹空格

re	修订，重新审视，基于 ‘re’ 模块。
结构化	结构增强文本，structuredtext。
文本	好吧，它就是，不是吗？