Skip to content

Commit bcde51e

Browse files
authored
DOP-1243: Modify admonition configuration (#181)
1 parent a3512dc commit bcde51e

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

snooty/rstspec.toml

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,51 +59,54 @@ ${4: :align:
5959
content_type = "block"
6060
argument_type = "string"
6161
options.class = "string"
62+
deprecated = true
6263
example = """.. admonition:: ${1:Title}
6364
6465
${2:Admonition content}
6566
"""
6667

6768
[directive.note]
6869
inherit = "admonition"
69-
example = """.. note::
70+
example = """.. note:: ${1:Title}
7071
71-
${1:Note block content}
72+
${2:Note block content}
7273
"""
7374

7475
[directive.warning]
7576
inherit = "admonition"
76-
example = """.. warning::
77+
example = """.. warning:: ${1:Title}
7778
78-
${1:Warning block content}
79+
${2:Warning block content}
7980
"""
8081

8182
[directive.important]
8283
inherit = "admonition"
83-
example = """.. important::
84+
example = """.. important:: ${1:Title}
8485
85-
${1:Important block content}
86+
${2:Important block content}
8687
"""
8788

8889
[directive.danger]
8990
inherit = "admonition"
91+
deprecated = true
9092
example = """.. danger::
9193
9294
${1:Danger block content}
9395
"""
9496

9597
[directive.caution]
9698
inherit = "admonition"
97-
example = """.. caution::
99+
deprecated = true
100+
example = """.. caution:: ${1:Title}
98101
99-
${1:Caution block content}
102+
${2:Caution block content}
100103
"""
101104

102105
[directive.tip]
103106
inherit = "admonition"
104-
example = """.. tip::
107+
example = """.. tip:: ${1:Title}
105108
106-
${1:Tip content}
109+
${2:Tip content}
107110
"""
108111

109112
[directive.versionchanged]
@@ -127,11 +130,17 @@ example = """.. deprecated:: ${1:v1.0}
127130
"""
128131

129132
[directive.see]
130-
argument_type = "string"
131-
content_type = "block"
132-
example = """.. see::
133+
inherit = "admonition"
134+
example = """.. see:: ${1:Title}
133135
134-
${1:String}
136+
${2:String}
137+
"""
138+
139+
[directive.seealso]
140+
inherit = "admonition"
141+
example = """.. seealso:: ${1:Title}
142+
143+
${2:String}
135144
"""
136145

137146
[directive.todo]
@@ -224,7 +233,7 @@ example = """.. image:: ${1:/path or uri.png}
224233

225234
[directive.example]
226235
help = """A section providing an example related to the surrounding text."""
227-
content_type = "block"
236+
inherit = "admonition"
228237
example = """.. example::
229238
230239
${0:Example}
@@ -588,7 +597,7 @@ inherit = "_guides-base"
588597
# * article example 2}
589598
# """
590599

591-
[directive.seealso]
600+
[directive."guide:seealso"]
592601
help = """Related pages. Typically a list."""
593602
inherit = "_guides-base"
594603
# example = """.. seealso::
@@ -884,6 +893,7 @@ example = """.. meta::
884893
help = """A block with a self-contained chunk of information."""
885894
argument_type = "string"
886895
content_type = "block"
896+
deprecated = true
887897
example = """.. topic:: ${1:Title of block}
888898
889899
${0:Content}

0 commit comments

Comments
 (0)