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
|
#! /usr/bin/env python3
# $Id: test_latex2e_misc.py 10003 2024-12-18 22:03:08Z milde $
# Author: Günter Milde
# Maintainer: docutils-develop@lists.sourceforge.net
# :Copyright: 2020 Günter Milde,
# :License: Released under the terms of the `2-Clause BSD license`_, in short:
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.
# This file is offered as-is, without any warranty.
#
# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
"""
Miscellaneous LaTeX writer tests.
"""
from pathlib import Path
import sys
import unittest
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[2]))
from docutils import core
from docutils.writers import latex2e
# TEST_ROOT is ./test/ from the docutils root
TEST_ROOT = Path(__file__).parents[1]
DATA_ROOT = TEST_ROOT / 'data'
sample_toc = """\
.. contents:: TOC
foo
---
bar
---
"""
sample_multiterm = f"""\
.. include:: {DATA_ROOT}/multiple-term-definition.xml
:parser: xml
"""
expected_multiterm = """
\\begin{description}
\\item[{New in Docutils 0.22}] \n\
A definition list item may contain several
terms with optional classifier(s).
However, there is currently no corresponding
reStructuredText syntax.
\\item[{term 2a}] \n\
\\item[{term 2b}] \n\
definition 2
\\item[{term 3a}] (\\textbf{classifier 3a})
(\\textbf{classifier 3aa})
\\item[{term 3b}] (\\textbf{classifier 3b})
definition 3
\\end{description}
"""
class PublishTestCase(unittest.TestCase):
maxDiff = None
settings = {'_disable_config': True,
# avoid latex writer future warnings:
'use_latex_citations': False,
'legacy_column_widths': False,
}
def test_publish_from_doctree(self):
"""Ignore the Docutils-generated ToC when ``use_latex_toc`` is True.
(This did happen when publishing from a doctree.)
"""
settings = self.settings.copy()
settings['output_encoding'] = 'unicode'
settings['warning_stream'] = '' # don't warn for missing ToC details
doctree = core.publish_doctree(sample_toc,
settings_overrides=settings)
result = core.publish_from_doctree(doctree,
writer=latex2e.Writer(),
settings_overrides=settings)
self.assertNotIn(r'\item \hyperref[foo]{foo}', result)
self.assertIn(r'\tableofcontents', result)
class WarningsTestCase(unittest.TestCase):
def test_future_warnings(self):
"""Warn about changing defaults."""
# Warn only if not set (uncommenting should make test fail):
settings = {'_disable_config': True,
# 'use_latex_citations': False,
# 'legacy_column_widths': True,
'output_encoding': 'unicode',
}
with self.assertWarnsRegex(FutureWarning,
'"legacy_column_widths" will change'):
core.publish_string('warnings test', writer=latex2e.Writer(),
settings_overrides=settings)
with self.assertWarnsRegex(FutureWarning,
'"use_latex_citations" will change'):
core.publish_string('warnings test', writer=latex2e.Writer(),
settings_overrides=settings)
def test_deprecation_warnings(self):
with self.assertWarnsRegex(DeprecationWarning, 'will be removed'):
latex2e.SortableDict(deprecated=True)
if __name__ == '__main__':
unittest.main()
|
