快捷方式

3. 段落级标记

3.1. 内联标记

段落包含文本,可能包含内联标记:强调粗体强调内联 文字、独立超链接 (https://www.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,以免与相邻行的文本 冲突

键盘绑定指示读取内容应按下键盘或鼠标上的按钮,例如 MMBShift-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. 行块

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

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

埃里克指挥家,开始演奏吧!

一、二、一、二、三、四

半只蜜蜂,哲学地,
必然,事实上,一半不会是。
但半只蜜蜂必须是,
与…相比它的实体。你看懂了吗?

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

唱歌……

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.6.0.dev0+b99d080.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)

此引用包含一些 code blocks,也许还有一些 粗体斜体。哎呀,让我们再放一个指向元引用的链接 13 也是。

13

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

这是对上面的引用,12,以及一个 [nonexistent] 引用。

这里还有另一种类型的引用:citation

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

5(1,2,3)

https://www.pythonlang.cn/

3.7.7. 替换文本

我建议您尝试使用 Python,是最好的语言 5

3.7.8. 复合段落

本段落包含一个文字块

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

因此它包含一个简单段落、一个文字块和另一个简单段落。但从语义上讲,它是一个段落。

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

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

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

查看教程

资源

查找开发资源并获得问题的解答

查看资源