forked from sphinx-doc/sphinx
/
test_directive_patch.py
94 lines (76 loc) · 3.28 KB
/
test_directive_patch.py
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
"""
test_directive_patch
~~~~~~~~~~~~~~~~~~~
Test the patched directives.
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
from docutils import nodes
from sphinx.testing import restructuredtext
from sphinx.testing.util import assert_node
def test_code_directive(app):
# normal case
text = ('.. code::\n'
'\n'
' print("hello world")\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, ([nodes.literal_block, 'print("hello world")'],
nodes.substitution_definition))
assert_node(doctree[0], language="default", highlight_args={})
# with language
text = ('.. code:: python\n'
'\n'
' print("hello world")\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, ([nodes.literal_block, 'print("hello world")'],
nodes.substitution_definition))
assert_node(doctree[0], language="python", highlight_args={})
# :number-lines: option
text = ('.. code:: python\n'
' :number-lines:\n'
'\n'
' print("hello world")\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, ([nodes.literal_block, 'print("hello world")'],
nodes.substitution_definition))
assert_node(doctree[0], language="python", linenos=True, highlight_args={})
# :number-lines: option
text = ('.. code:: python\n'
' :number-lines: 5\n'
'\n'
' print("hello world")\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, ([nodes.literal_block, 'print("hello world")'],
nodes.substitution_definition))
assert_node(doctree[0], language="python", linenos=True, highlight_args={'linenostart': 5})
def test_math_directive(app):
# normal case
text = '.. math:: E = mc^2'
doctree = restructuredtext.parse(app, text)
assert_node(doctree, ([nodes.math_block, "E = mc^2\n\n"],
nodes.substitution_definition))
# :name: option
text = ('.. math:: E = mc^2\n'
' :name: eq1\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, (nodes.target,
[nodes.math_block, "E = mc^2\n\n"],
nodes.substitution_definition))
assert_node(doctree[1], nodes.math_block, docname='index', label="eq1", number=1)
# :label: option
text = ('.. math:: E = mc^2\n'
' :label: eq2\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, (nodes.target,
[nodes.math_block, "E = mc^2\n\n"],
nodes.substitution_definition))
assert_node(doctree[1], nodes.math_block, docname='index', label="eq2", number=2)
# :label: option without value
text = ('.. math:: E = mc^2\n'
' :label:\n')
doctree = restructuredtext.parse(app, text)
assert_node(doctree, (nodes.target,
[nodes.math_block, "E = mc^2\n\n"],
nodes.substitution_definition))
assert_node(doctree[1], nodes.math_block, ids=['equation-index-0'],
docname='index', label="index:0", number=3)