Admonitions#
Sphinx provides several different types of admonitions.
topic#
admonition#
The one with the custom titles
It's got a certain charm to it.
attention#
注意
Climate change is real.
caution#
小心
Cliff ahead: Don't drive off it.
danger#
危险
Mad scientist at work!
error#
错误
Does not compute.
hint#
提示
Insulators insulate, until they are subject to ______ voltage.
important#
重要
Tech is not neutral, nor is it apolitical.
note#
备注
This is a note.
seealso#
参见
Other relevant information.
tip#
小技巧
25% if the service is good.
todo#
待处理
This needs the sphinx.ext.todo extension.
warning#
警告
Reader discretion is strongly advised.
versionadded#
Added in version v0.1.1: Here's a version added message.
versionchanged#
在 v0.1.1 版本发生变更: Here's a version changed message.
deprecated#
自 v0.1.1 版本弃用: Here's a deprecation message.