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
|
# -*- coding: utf-8 -*-
"""
test_build
~~~~~~~~~~
Test all builders.
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
from six import BytesIO
from textwrap import dedent
from sphinx.errors import SphinxError
from util import with_app, rootdir, tempdir, SkipTest, TestApp
try:
from docutils.writers.manpage import Writer as ManWriter
except ImportError:
ManWriter = None
class MockOpener(object):
def open(self, req, **kwargs):
class result(BytesIO):
headers = None
url = req.url
return result()
import sphinx.builders.linkcheck
sphinx.builders.linkcheck.opener = MockOpener()
def verify_build(buildername, srcdir):
if buildername == 'man' and ManWriter is None:
raise SkipTest('man writer is not available')
app = TestApp(buildername=buildername, srcdir=srcdir)
try:
app.builder.build_all()
finally:
app.cleanup()
def test_build_all():
# If supported, build in a non-ASCII source dir
test_name = u'\u65e5\u672c\u8a9e'
try:
srcdir = tempdir / test_name
(rootdir / 'root').copytree(tempdir / test_name)
except UnicodeEncodeError:
srcdir = tempdir / 'all'
else:
# add a doc with a non-ASCII file name to the source dir
(srcdir / (test_name + '.txt')).write_text(dedent("""
nonascii file name page
=======================
"""))
master_doc = srcdir / 'contents.txt'
master_doc.write_text(master_doc.text() + dedent(u"""
.. toctree::
%(test_name)s/%(test_name)s
""" % {'test_name': test_name})
)
# note: no 'html' - if it's ok with dirhtml it's ok with html
for buildername in ['dirhtml', 'singlehtml', 'latex', 'texinfo', 'pickle',
'json', 'text', 'htmlhelp', 'qthelp', 'epub',
'applehelp', 'changes', 'xml', 'pseudoxml', 'man',
'linkcheck']:
yield verify_build, buildername, srcdir
@with_app(buildername='text')
def test_master_doc_not_found(app, status, warning):
(app.srcdir / 'contents.txt').move(app.srcdir / 'contents.txt.bak')
try:
app.builder.build_all()
assert False # SphinxError not raised
except Exception as exc:
assert isinstance(exc, SphinxError)
finally:
(app.srcdir / 'contents.txt.bak').move(app.srcdir / 'contents.txt')
@with_app(buildername='text', testroot='circular')
def test_circular_toctree(app, status, warning):
app.builder.build_all()
warnings = warning.getvalue()
assert (
'circular toctree references detected, ignoring: '
'sub <- contents <- sub') in warnings
assert (
'circular toctree references detected, ignoring: '
'contents <- sub <- contents') in warnings
@with_app(buildername='text', testroot='numbered-circular')
def test_numbered_circular_toctree(app, status, warning):
app.builder.build_all()
warnings = warning.getvalue()
assert (
'circular toctree references detected, ignoring: '
'sub <- contents <- sub') in warnings
assert (
'circular toctree references detected, ignoring: '
'contents <- sub <- contents') in warnings
|
