Admonitions

Sphinx provides several different types of admonitions.

topic

This is a topic.

This is what admonitions are a special case of, according to the docutils documentation.

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

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.