• 文档 >
  • 3. 段落级别标记
快捷方式

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 标签不应超出 行高,以免 干扰 邻近行的文本。

键绑定指示读者需要按下键盘或鼠标上的按钮,例如 MMBShift-MMB。另一种指示用户操作的有用标记是使用 菜单选择,这可用于在软件中显示短菜单和长菜单。例如,此处可见 菜单选择,它太长而无法容纳在一行中。 我的 ‣ 软件 ‣ 某个菜单 ‣ 某个子菜单 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. 行块

这是一个行块。它以空行结束。
每个新行都以竖线(“|”)开头。
保留换行符和初始缩进。
续行是长行的换行部分;它们以空格代替竖线开头。
续行的左边缘不必与上方文本的左边缘对齐。
这是第二个行块。

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

交给埃里克乐队指挥吧!

一,二,一二三四

从哲学上讲,半只蜜蜂,
必然,根据事实,必然不是一半。
但半只蜜蜂必须存在,
就其存在而言。你明白吗?

但能说一只蜜蜂存在
或不存在一只完整的蜜蜂吗,
当半只蜜蜂不是蜜蜂时,
由于某种古老的伤害?

唱着…

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.8.0.dev0+3b30409.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. 脚注

1(1,2)

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

这是脚注的第二段。

2(1,2)

脚注可以手动编号 (如 1) 或使用以“#”为前缀的标签自动编号。此脚注带有标签,因此可以从多个地方引用,既可以作为脚注引用 (2),也可以作为超链接引用 (label)。

3

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

*

脚注也可以使用符号,通过“*”标签指定。这是对下一个脚注的引用:

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

4

这是一个未引用的脚注,引用了一个不存在的脚注:[5]_

3.6.2. 引文

11

这是我引用的文献,我们把它弄得非常长,以便可以看出它不遵循正常的响应式表格规则。

12(1,2)

这个引文包含一些 代码块,可能还有一些 粗体斜体。哎呀,我们甚至放一个指向元引文 13 的链接。

13

此引文将有两个反向链接。

这是对上面引文的引用,12,以及一个 [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' 模块。

Structured

结构增强文本,structuredtext。

Text

嗯,确实是,不是吗?

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

一个带居中对齐的图指令

../../../../_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. 目标脚注

5(1,2,3)

https://pythonlang.cn/

3.7.7. 替换文本

我建议你尝试Python,最好的语言 5

3.7.8. 复合段落

此段落包含一个字面块

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

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

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

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取针对初学者和高级开发者的深度教程

查看教程

资源

查找开发资源并获得解答

查看资源