特定信息块¶
使用特殊标记来强调文档中的特定信息。根据消息的具体语义,可以使用
注意 - 用于具有通用含义的消息。
警告 或 重要 - 包含用户可能容易忽略但应该注意的细节,在继续操作前很有价值。
小心 - 传递信息,防止用户在遵循程序时犯错和产生不良后果。
提示 或 参见 - 包含额外的但有用的信息。
以下是 `note` 指令的使用示例;这些可以应用于上述所有提示指令。
输入
.. note::
This is the text of a generic admonition.
This line is the continuation of the first line.
A note may contain bulleted or enumerated lists,
as well as code blocks:
* First option,
* ...
输出
注意
这是 `note` 提示的文本。这一行是第一行的延续。
`note` 可以包含项目符号或编号列表,以及代码块
第一个选项,
…