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
|
#! /usr/bin/env python3
# $Id$
# Authors: Lea Wiemann, Dmitry Shachnev, Günter Milde
# Maintainer: docutils-develop@lists.sourceforge.net
# Copyright: This module has been placed in the public domain.
"""
Miscellaneous HTML writer tests.
"""
import os
import unittest
from docutils import core
# TEST_ROOT is ./test/ from the docutils root
TEST_ROOT = os.path.abspath(os.path.join(__file__, '..', '..'))
# DATA_ROOT is ./test/data/ from the docutils root
DATA_ROOT = os.path.join(TEST_ROOT, 'data')
def relpath(*parts):
return os.path.relpath(os.path.join(*parts), os.getcwd()).replace('\\', '/')
class EncodingTestCase(unittest.TestCase):
def test_xmlcharrefreplace(self):
# Test that xmlcharrefreplace is the default output encoding
# error handler.
settings_overrides = {
'output_encoding': 'latin1',
'stylesheet': '',
'_disable_config': True,
}
result = bytes(core.publish_string(
'EUR = \u20ac', writer_name='html4css1',
settings_overrides=settings_overrides))
# Encoding a euro sign with latin1 doesn't work, so the
# xmlcharrefreplace handler is used.
self.assertIn(b'EUR = €', result)
class MovingArgsTestCase(unittest.TestCase):
mys = {'stylesheet_path': '',
# 'embed_stylesheet': False,
'_disable_config': True,
}
def test_definition_list_item_classes(self):
# Do not drop class arguments for the definition list item.
# Pass them to to the term node instead.
data = """\
first term:
fist def
.. class:: for the second item
second term:
second def
"""
result = core.publish_string(data, writer_name='html4css1',
settings_overrides=self.mys)
self.assertIn(b'<dt class="for the second item">second term:</dt>',
result)
def test_definition_list_item_name(self):
# Do not drop the "name" of the definition list item.
# Pass it to to the term node instead.
data = """\
first term:
first def
.. _second item:
second term:
second def
"""
result = core.publish_string(data, writer_name='html4css1',
settings_overrides=self.mys)
self.assertIn(b'<dt id="second-item">second term:</dt>',
result)
ham_css = relpath(DATA_ROOT, 'ham.css')
class SettingsTestCase(unittest.TestCase):
data = 'test'
def test_default_stylesheet(self):
# default style sheet, embedded
mys = {'_disable_config': True}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('Default cascading style sheet '
'for the HTML output of Docutils.', styles)
def test_default_stylesheet_linked(self):
# default style sheet, linked
mys = {'_disable_config': True,
'embed_stylesheet': False}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
def test_math_stylesheet_linked(self):
# default + math style sheet, linked
mys = {'_disable_config': True,
'embed_stylesheet': False,
'stylesheet_path': 'html4css1.css, math.css'}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
self.assertIn('docutils/writers/html5_polyglot/math.css', styles)
def test_custom_stylesheet_linked(self):
# default + custom style sheet, linked
mys = {'_disable_config': True,
'embed_stylesheet': False,
'stylesheet_path': 'html4css1.css, '
'data/ham.css'}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
self.assertIn('href="data/ham.css"', styles)
def test_custom_stylesheet_dir(self):
mys = {'_disable_config': True,
'embed_stylesheet': False,
'stylesheet_dirs': (
os.path.join(TEST_ROOT, '../docutils/writers/html4css1/'),
DATA_ROOT),
'stylesheet_path': 'html4css1.css, ham.css'}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
if os.path.isdir(os.path.join(TEST_ROOT, '../docutils/writers/html4css1/')):
self.assertIn('docutils/writers/html4css1/html4css1.css', styles)
self.assertIn(f'href="{ham_css}"', styles)
def test_custom_stylesheet_dir_embedded(self):
mys = {'_disable_config': True,
'embed_stylesheet': True,
'stylesheet_dirs': (
os.path.join(TEST_ROOT, '../docutils/writers/html4css1/'),
DATA_ROOT),
'stylesheet_path': 'ham.css'}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('dl.docutils dd {\n margin-bottom: 0.5em }', styles)
html4css1_css = relpath(TEST_ROOT, 'functional/input/data/html4css1.css')
math_css = relpath(TEST_ROOT, 'functional/input/data/math.css')
class MathTestCase(unittest.TestCase):
"""Attention: This class tests the current implementation of maths support
which is open to change in future Docutils releases. """
mathjax_script = '<script type="text/javascript" src="%s">'
default_mathjax_url = ('file:/usr/share/javascript/mathjax/MathJax.js'
'?config=TeX-AMS_CHTML')
custom_mathjax_url = '/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
data = ':math:`42`'
def test_math_output_default(self):
# HTML with math.css stylesheet (since 0.11)
mys = {'_disable_config': True}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertIn('convert LaTeX equations to HTML output.', styles)
def test_math_output_mathjax(self):
# Explicitly specifying math_output=MathJax, case insensitively
# use default MathJax URL
mys = {'_disable_config': True,
'report_level': 3,
'math_output': 'MathJax'}
head = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['head']
self.assertIn(self.mathjax_script % self.default_mathjax_url, head)
def test_math_output_mathjax_custom(self):
# Customizing MathJax URL
mys = {'_disable_config': True,
'math_output':
'mathjax %s' % self.custom_mathjax_url}
head = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['head']
self.assertIn(self.mathjax_script % self.custom_mathjax_url, head)
def test_math_output_html(self):
mys = {'_disable_config': True,
'math_output': 'HTML'}
head = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['head']
# There should be no MathJax script when math_output is not MathJax
self.assertNotIn('MathJax.js', head)
def test_math_output_html_stylesheet(self):
mys = {'_disable_config': True,
'math_output': 'HTML math.css,custom/style.css',
'stylesheet_dirs': (
TEST_ROOT,
os.path.join(TEST_ROOT, 'functional/input/data')),
'embed_stylesheet': False}
styles = core.publish_parts(self.data, writer_name='html4css1',
settings_overrides=mys)['stylesheet']
self.assertEqual(f"""\
<link rel="stylesheet" href="{html4css1_css}" type="text/css" />
<link rel="stylesheet" href="{math_css}" type="text/css" />
<link rel="stylesheet" href="custom/style.css" type="text/css" />
""", styles)
def test_math_output_mathjax_no_math(self):
# There should be no math script when text does not contain math
head = core.publish_parts('No math.', writer_name='html4css1')['head']
self.assertNotIn('MathJax', head)
if __name__ == '__main__':
unittest.main()
|
