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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
#! /usr/bin/env python3
# $Id: test_contents.py 9037 2022-03-05 23:31:10Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for parts.py contents directive.
"""
if __name__ == '__main__':
import __init__ # noqa: F401
from test_parsers import DocutilsTestSupport
def suite():
s = DocutilsTestSupport.ParserTestSuite()
s.generateTests(totest)
return s
totest = {}
totest['contents'] = [
["""\
.. contents::
""",
"""\
<document source="test data">
<topic classes="contents" ids="contents" names="contents">
<title>
Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
["""\
.. contents:: Table of Contents
""",
"""\
<document source="test data">
<topic classes="contents" ids="table-of-contents" names="table\\ of\\ contents">
<title>
Table of Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
["""\
.. contents::
Table of Contents
""",
"""\
<document source="test data">
<topic classes="contents" ids="table-of-contents" names="table\\ of\\ contents">
<title>
Table of Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
["""\
.. contents:: Table
of
Contents
""",
"""\
<document source="test data">
<topic classes="contents" ids="table-of-contents" names="table\\ of\\ contents">
<title>
Table
of
Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
["""\
.. contents:: *Table* of ``Contents``
""",
"""\
<document source="test data">
<topic classes="contents" ids="table-of-contents" names="table\\ of\\ contents">
<title>
<emphasis>
Table
of \n\
<literal>
Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
["""\
.. contents::
:depth: 2
:local:
""",
"""\
<document source="test data">
<topic classes="contents local" ids="contents" names="contents">
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
depth: 2
local: None
"""],
["""\
.. contents::
:local: arg
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "contents" directive:
invalid option value: (option: "local"; value: 'arg')
no argument is allowed; "arg" supplied.
<literal_block xml:space="preserve">
.. contents::
:local: arg
"""],
["""\
.. contents:: Table of Contents
:local:
:depth: 2
:backlinks: none
""",
"""\
<document source="test data">
<topic classes="contents local" ids="table-of-contents" names="table\\ of\\ contents">
<title>
Table of Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
backlinks: None
depth: 2
local: None
"""],
["""\
.. contents::
:depth: two
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "contents" directive:
invalid option value: (option: "depth"; value: 'two')
%s.
<literal_block xml:space="preserve">
.. contents::
:depth: two
""" % DocutilsTestSupport.exception_data(int, "two")[1][0]],
["""\
.. contents::
:width: 2
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "contents" directive:
unknown option: "width".
<literal_block xml:space="preserve">
.. contents::
:width: 2
"""],
["""\
.. contents::
:backlinks: no way!
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "contents" directive:
invalid option value: (option: "backlinks"; value: 'no way!')
"no way!" unknown; choose from "top", "entry", or "none".
<literal_block xml:space="preserve">
.. contents::
:backlinks: no way!
"""],
["""\
.. contents::
:backlinks:
""",
"""\
<document source="test data">
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
Error in "contents" directive:
invalid option value: (option: "backlinks"; value: None)
must supply an argument; choose from "top", "entry", or "none".
<literal_block xml:space="preserve">
.. contents::
:backlinks:
"""],
["""\
* .. contents::
""",
"""\
<document source="test data">
<bullet_list bullet="*">
<list_item>
<system_message level="3" line="1" source="test data" type="ERROR">
<paragraph>
The "contents" directive may not be used within topics or body elements.
<literal_block xml:space="preserve">
.. contents::
"""],
["""\
.. sidebar:: containing contents
.. contents::
""",
"""\
<document source="test data">
<sidebar>
<title>
containing contents
<topic classes="contents" ids="contents" names="contents">
<title>
Contents
<pending>
.. internal attributes:
.transform: docutils.transforms.parts.Contents
.details:
"""],
]
if __name__ == '__main__':
import unittest
unittest.main(defaultTest='suite')
|
