mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
d47a7587f9
* rename a few test modules to make the names more consistent * do not copy/use Sphinx from build/ (unnecessary without 2to3) * use a temporary dir for *all* test projects, the source tree will stay pristine that way (default is tests/build) * speed up tests by ~3x by splitting up test projects and avoiding rebuilds
49 lines
1.7 KiB
Python
49 lines
1.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_coverage
|
|
~~~~~~~~~~~~~
|
|
|
|
Test the coverage builder.
|
|
|
|
:copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import pickle
|
|
|
|
from util import with_app
|
|
|
|
|
|
@with_app(buildername='coverage')
|
|
def test_build(app, status, warning):
|
|
app.builder.build_all()
|
|
|
|
py_undoc = (app.outdir / 'python.txt').text()
|
|
assert py_undoc.startswith('Undocumented Python objects\n'
|
|
'===========================\n')
|
|
assert 'test_autodoc\n------------\n' in py_undoc
|
|
assert ' * Class -- missing methods:\n' in py_undoc
|
|
assert ' * process_docstring\n' in py_undoc
|
|
assert ' * function\n' not in py_undoc # these two are documented
|
|
assert ' * Class\n' not in py_undoc # in autodoc.txt
|
|
|
|
assert ' * mod -- No module named mod' # in the "failed import" section
|
|
|
|
c_undoc = (app.outdir / 'c.txt').text()
|
|
assert c_undoc.startswith('Undocumented C API elements\n'
|
|
'===========================\n')
|
|
assert 'api.h' in c_undoc
|
|
assert ' * Py_SphinxTest' in c_undoc
|
|
|
|
undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').bytes())
|
|
assert len(undoc_c) == 1
|
|
# the key is the full path to the header file, which isn't testable
|
|
assert list(undoc_c.values())[0] == [('function', 'Py_SphinxTest')]
|
|
|
|
assert 'test_autodoc' in undoc_py
|
|
assert 'funcs' in undoc_py['test_autodoc']
|
|
assert 'process_docstring' in undoc_py['test_autodoc']['funcs']
|
|
assert 'classes' in undoc_py['test_autodoc']
|
|
assert 'Class' in undoc_py['test_autodoc']['classes']
|
|
assert 'undocmeth' in undoc_py['test_autodoc']['classes']['Class']
|