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
|
# -*- coding: utf-8 -*-
# Licensed under a 3-clause BSD style license - see LICENSE.rst
import os
from copy import deepcopy
from sphinx.cmd.build import build_main
from . import cython_testpackage # noqa
__all__ = ['write_conf', 'run_sphinx_in_tmpdir']
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None)
}
DEFAULT_CONF = {'source_suffix': '.rst',
'master_doc': 'index',
'nitpicky': True,
'extensions': ['sphinx.ext.intersphinx', 'sphinx_automodapi.automodapi'],
'suppress_warnings': ['app.add_directive', 'app.add_node'],
'intersphinx_mapping': intersphinx_mapping,
'automodapi_toctreedirnm': 'api',
'automodapi_writereprocessed': True,
'automodapi_inheritance_diagram': True,
'automodsumm_writereprocessed': True}
def write_conf(filename, conf):
with open(filename, 'w') as f:
for key, value in conf.items():
f.write("{0} = {1}\n".format(key, repr(conf[key])))
def run_sphinx_in_tmpdir(tmpdir, additional_conf={}, expect_error=False):
start_dir = os.path.abspath('.')
conf = deepcopy(DEFAULT_CONF)
conf.update(additional_conf)
write_conf(tmpdir.join('conf.py').strpath, conf)
argv = ['-W', '-b', 'html', '.', '_build/html']
try:
os.chdir(tmpdir.strpath)
status = build_main(argv=argv)
finally:
os.chdir(start_dir)
if expect_error:
assert status != 0
else:
assert status == 0
|
