c6b55af713
Sphinx supports various notice blocks but the oslosphinx theme does support only warning and note. openstackdoctheme used by openstack-manuals project supports 'important', 'tip' and 'caution' blocks. It would be nice if oslosphinx support these notices. It reduces confusions on contributors to both types of projects. Change-Id: I3e1db551b05fa681520763c24e2576f9ad5379d8
26 lines
488 B
ReStructuredText
26 lines
488 B
ReStructuredText
===========
|
|
Theme check
|
|
===========
|
|
|
|
This page is used to check the themes provided by oslosphinx.
|
|
|
|
.. note::
|
|
|
|
A comment with additional information that explains a part of the text.
|
|
|
|
.. important::
|
|
|
|
Something you must be aware of before proceeding.
|
|
|
|
.. tip::
|
|
|
|
An extra but helpful piece of practical advice.
|
|
|
|
.. Caution::
|
|
|
|
Helpful information that prevents the user from making mistakes.
|
|
|
|
.. Warning::
|
|
|
|
Critical information about the risk of data loss or security issues.
|