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. 行块 ¶

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

每一新行都以竖线（“|”）开头。

保留换行符和初始缩进。

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

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

这是第二个行块。

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

来吧，埃里克管弦乐队指挥！

一，二，一二三四

半只蜜蜂，从哲学上讲，

必须，事实上，半只不是。 D’you see?

但半只蜜蜂必然是，

vis a vis 它的实体。 D’you see?

但蜜蜂可以被说成是

或不是一只完整的蜜蜂，

当半只蜜蜂不是蜜蜂时，

由于某种古老的伤害？

唱歌……

3.4.3. 块引用 ¶

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

我的理论，作者 A. Elk 女士，括号，括号。这个理论如下，现在开始。所有的雷龙在末端都很细，中间要粗得多，然后又在远端变细。这就是我的理论，是我的，属于我，我拥有它，而且它就是这样。

—Anne Elk (Miss)

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.10.0.dev0+ab2e6e3.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），也作为超链接引用（标签）。

3

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

*

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

†

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

4

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

3.6.2. 引文 ¶

11: 这是我做的引文，让我们把它写得非常长，以便我们可以看出它不遵循常规的响应式表格样式。
12(1,2): 这个引文包含一些 代码块，也许还有一些粗体和斜体。甚至，我们还可以链接到一个元引文 13。
13: 这个引文将有两个反向链接。

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

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

3.6.3. 术语表 ¶

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

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

3.6.4. 目标 ¶

此段落由显式“示例”目标指向。可以在上面的行内标记中找到一个引用。也可能存在行内超链接目标。

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

显式的外部目标被插入到诸如“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. 下载链接 ¶

This long long long long long long long long long long long long long long long long download link should be blue, normal weight text with a leading icon, and should wrap white-spaces

re	修订版，重新审视，基于‘re’模块。
结构化的	增强结构文本，structuredtext。
文本	嗯，它确实是，不是吗？