在python-sphinx生成的页面上显示警告框

时间:2018-04-27 20:35:59

标签: python-sphinx restructuredtext

如何在使用sphinx-build生成的html中显示警告框?

Warning

Do not use the directives sectnum, header and footer.

我想将上述消息显示为: image of warning message in box(道歉,SO不允许我在这里的帖子中嵌入图片)
请忽略文本格式,我的主要目的是显示带有一些文字的框以引起用户的注意like on sphinx-doc site

1 个答案:

答案 0 :(得分:2)

您需要的reStructuredText语法适用于名为admonition directives的内容。

documentation source

中存在具体示例
.. warning::

   Do *not* use the directives :dudir:`sectnum`, :dudir:`header` and
   :dudir:`footer`.