1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
..
Copyright (c) 2021 Pradyun Gedam
Licensed under Creative Commons Attribution-ShareAlike 4.0 International License
SPDX-License-Identifier: CC-BY-SA-4.0
===========
Admonitions
===========
Sphinx provides several different types of admonitions.
``topic``
=========
.. topic:: This is a topic.
This is what admonitions are a special case of, according to the docutils
documentation.
``admonition``
==============
.. admonition:: The one with the custom titles
It's got a certain charm to it.
``attention``
=============
.. attention::
Climate change is real.
``caution``
===========
.. caution::
Cliff ahead: Don't drive off it.
``danger``
==========
.. danger::
Mad scientist at work!
``error``
=========
.. error::
Does not compute.
``hint``
========
.. hint::
Insulators insulate, until they are subject to ______ voltage.
``important``
=============
.. important::
Tech is not neutral, nor is it apolitical.
``note``
========
.. note::
This is a note.
``seealso``
===========
.. seealso::
Other relevant information.
``tip``
=======
.. tip::
25% if the service is good.
``todo``
========
.. todo::
This needs the ``sphinx.ext.todo`` extension.
``warning``
===========
.. warning::
Reader discretion is strongly advised.
``versionadded``
================
.. versionadded:: v0.1.1
Here's a version added message.
``versionchanged``
==================
.. versionchanged:: v0.1.1
Here's a version changed message.
``deprecated``
==============
.. deprecated:: v0.1.1
Here's a deprecation message.
|
