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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
#! /usr/bin/env python
# $Id: test_doctitle.py 7595 2013-01-21 17:33:56Z milde $
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Tests for docutils.transforms.frontmatter.DocTitle.
"""
from __init__ import DocutilsTestSupport
from docutils.transforms.frontmatter import DocTitle, SectionSubTitle
from docutils.parsers.rst import Parser, Directive
from docutils.parsers.rst.directives import register_directive
# dummy directive to test attribute merging:
class AddNameToDocumentTitle(Directive):
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = True
option_spec = { }
has_content = False
def run(self):
document = self.state_machine.document
document['names'].append('Name')
return []
register_directive('add-name-to-title', AddNameToDocumentTitle)
def suite():
parser = Parser()
s = DocutilsTestSupport.TransformTestSuite(parser)
s.generateTests(totest)
return s
totest = {}
totest['section_headers'] = ((DocTitle, SectionSubTitle), [
["""\
.. test title promotion
Title
=====
Paragraph.
""",
"""\
<document ids="title" names="title" source="test data" title="Title">
<title>
Title
<comment xml:space="preserve">
test title promotion
<paragraph>
Paragraph.
"""],
["""\
Title
=====
Paragraph (no blank line).
""",
"""\
<document ids="title" names="title" source="test data" title="Title">
<title>
Title
<paragraph>
Paragraph (no blank line).
"""],
["""\
Paragraph.
Title
=====
Paragraph.
""",
"""\
<document source="test data">
<paragraph>
Paragraph.
<section ids="title" names="title">
<title>
Title
<paragraph>
Paragraph.
"""],
["""\
Title
=====
Subtitle
--------
.. title:: Another Title
Test title, subtitle, and title metadata.
""",
"""\
<document ids="title" names="title" source="test data" title="Another Title">
<title>
Title
<subtitle ids="subtitle" names="subtitle">
Subtitle
<paragraph>
Test title, subtitle, and title metadata.
"""],
["""\
Title
====
Test short underline.
""",
"""\
<document ids="title" names="title" source="test data" title="Title">
<title>
Title
<system_message level="2" line="2" source="test data" type="WARNING">
<paragraph>
Title underline too short.
<literal_block xml:space="preserve">
Title
====
<paragraph>
Test short underline.
"""],
["""\
=======
Long Title
=======
Test long title and space normalization.
The system_message should move after the document title
(it was before the beginning of the section).
""",
"""\
<document ids="long-title" names="long\ title" source="test data" title="Long Title">
<title>
Long Title
<system_message level="2" line="1" source="test data" type="WARNING">
<paragraph>
Title overline too short.
<literal_block xml:space="preserve">
=======
Long Title
=======
<paragraph>
Test long title and space normalization.
The system_message should move after the document title
(it was before the beginning of the section).
"""],
["""\
.. Test multiple second-level titles.
Title 1
=======
Paragraph 1.
Title 2
-------
Paragraph 2.
Title 3
-------
Paragraph 3.
""",
"""\
<document ids="title-1" names="title\ 1" source="test data" title="Title 1">
<title>
Title 1
<comment xml:space="preserve">
Test multiple second-level titles.
<paragraph>
Paragraph 1.
<section ids="title-2" names="title\ 2">
<title>
Title 2
<paragraph>
Paragraph 2.
<section ids="title-3" names="title\ 3">
<title>
Title 3
<paragraph>
Paragraph 3.
"""],
["""\
.. |foo| replace:: bar
.. _invisible target:
Title
=====
This title should be the document title despite the
substitution_definition.
""",
"""\
<document ids="title" names="title" source="test data" title="Title">
<title>
Title
<substitution_definition names="foo">
bar
<target ids="invisible-target" names="invisible\ target">
<paragraph>
This title should be the document title despite the
substitution_definition.
"""],
["""\
(Because of this paragraph, the following is not a doc title.)
===============
Section Title
===============
Subtitle
========
-----------------
Another Section
-----------------
Another Subtitle
----------------
""",
"""\
<document source="test data">
<paragraph>
(Because of this paragraph, the following is not a doc title.)
<section ids="section-title" names="section\ title">
<title>
Section Title
<subtitle ids="subtitle" names="subtitle">
Subtitle
<section ids="another-section" names="another\ section">
<title>
Another Section
<subtitle ids="another-subtitle" names="another\ subtitle">
Another Subtitle
"""],
["""\
-----
Title
-----
This is a document, it flows nicely, so the attributes of it are at the
bottom.
.. add-name-to-title::
""",
"""\
<document ids="title" names="Name title" source="test data" title="Title">
<title>
Title
<paragraph>
This is a document, it flows nicely, so the attributes of it are at the
bottom.
"""]
])
if __name__ == '__main__':
import unittest
unittest.main(defaultTest='suite')
|
