summaryrefslogtreecommitdiff
path: root/docutils/test/test_writers/test_latex2e_misc.py
blob: a11f24c5e80769a7b9dadc54cb89d0f83f567785 (plain)
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
#! /usr/bin/env python3
# $Id$
# 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.
"""

import unittest

from docutils import core

contents_test_input = """\
.. contents:: TOC

foo
---

bar
---

"""


class PublishTestCase(unittest.TestCase):

    settings = {'_disable_config': True,
                # avoid latex writer future warnings:
                'use_latex_citations': False,
                'legacy_column_widths': True,
                }

    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'
        doctree = core.publish_doctree(contents_test_input,
                                       settings_overrides=settings)
        result = core.publish_from_doctree(doctree,
                                           writer_name='latex',
                                           settings_overrides=settings)
        self.assertNotIn(r'\item \hyperref[foo]{foo}', result)
        # self.assertIn(r'\tableofcontents', result)

    def test_publish_parts(self):
        """Check for the presence of documented parts.
        """
        # parts = core.publish_parts(contents_test_input,
        #                            settings_overrides=self.settings)
        # documented_parts = [
        #     'abstract',
        #     'body',
        #     'body_pre_docinfo',
        #     'dedication',
        #     'docinfo',
        #     'encoding',
        #     'fallbacks',
        #     'head_prefix',
        #     'latex_preamble',
        #     'pdfsetup',
        #     'requirements',
        #     'stylesheet',
        #     'subtitle',
        #     'title',
        #     'titledata',
        #     'version',
        #     'whole'
        #     ]
        # TODO: activate and fix test.
        # self.assertEqual(sorted(parts.keys()), documented_parts)


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_name='latex',
                                settings_overrides=settings)
        with self.assertWarnsRegex(FutureWarning,
                                   '"use_latex_citations" will change'):
            core.publish_string('warnings test', writer_name='latex',
                                settings_overrides=settings)


if __name__ == '__main__':
    unittest.main()