mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
3ba60ffd5d
* Adds nesting to the JavaScript domain, to allow for nesting of elements * Adds the ``js:module`` directive, which behaves similarly to the Python directive * Adds the ``js:method`` directive, an alias to ``js:function`` * Adds roles for ``js:mod`` and ``js:meth`` * Updates tests to passing cases * Adds docs for new features
139 lines
6.4 KiB
Python
139 lines
6.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_domain_js
|
|
~~~~~~~~~~~~~~
|
|
|
|
Tests the JavaScript Domain
|
|
|
|
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import pytest
|
|
from sphinx import addnodes
|
|
|
|
from util import assert_node
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='domain-js')
|
|
def test_domain_js_xrefs(app, status, warning):
|
|
"""Domain objects have correct prefixes when looking up xrefs"""
|
|
app.builder.build_all()
|
|
|
|
def assert_refnode(node, mod_name, prefix, target, reftype=None,
|
|
domain='js'):
|
|
attributes = {
|
|
'refdomain': domain,
|
|
'reftarget': target,
|
|
}
|
|
if reftype is not None:
|
|
attributes['reftype'] = reftype
|
|
if mod_name is not False:
|
|
attributes['js:module'] = mod_name
|
|
if prefix is not False:
|
|
attributes['js:object'] = prefix
|
|
assert_node(node, **attributes)
|
|
|
|
doctree = app.env.get_doctree('roles')
|
|
refnodes = list(doctree.traverse(addnodes.pending_xref))
|
|
assert_refnode(refnodes[0], None, None, u'TopLevel', u'class')
|
|
assert_refnode(refnodes[1], None, None, u'top_level', u'func')
|
|
assert_refnode(refnodes[2], None, u'NestedParentA', u'child_1', u'func')
|
|
assert_refnode(refnodes[3], None, u'NestedParentA',
|
|
u'NestedChildA.subchild_2', u'func')
|
|
assert_refnode(refnodes[4], None, u'NestedParentA', u'child_2', u'func')
|
|
assert_refnode(refnodes[5], False, u'NestedParentA', u'any_child', domain='')
|
|
assert_refnode(refnodes[6], None, u'NestedParentA', u'NestedChildA', u'class')
|
|
assert_refnode(refnodes[7], None, u'NestedParentA.NestedChildA',
|
|
u'subchild_2', u'func')
|
|
assert_refnode(refnodes[8], None, u'NestedParentA.NestedChildA',
|
|
u'NestedParentA.child_1', u'func')
|
|
assert_refnode(refnodes[9], None, u'NestedParentA',
|
|
u'NestedChildA.subchild_1', u'func')
|
|
assert_refnode(refnodes[10], None, u'NestedParentB', u'child_1', u'func')
|
|
assert_refnode(refnodes[11], None, u'NestedParentB', u'NestedParentB',
|
|
u'class')
|
|
assert_refnode(refnodes[12], None, None, u'NestedParentA.NestedChildA',
|
|
u'class')
|
|
assert len(refnodes) == 13
|
|
|
|
doctree = app.env.get_doctree('module')
|
|
refnodes = list(doctree.traverse(addnodes.pending_xref))
|
|
assert_refnode(refnodes[0], 'module_a.submodule', None, 'ModTopLevel',
|
|
'class')
|
|
assert_refnode(refnodes[1], 'module_a.submodule', 'ModTopLevel',
|
|
'mod_child_1', 'meth')
|
|
assert_refnode(refnodes[2], 'module_a.submodule', 'ModTopLevel',
|
|
'ModTopLevel.mod_child_1', 'meth')
|
|
assert_refnode(refnodes[3], 'module_a.submodule', 'ModTopLevel',
|
|
'mod_child_2', 'meth')
|
|
assert_refnode(refnodes[4], 'module_a.submodule', 'ModTopLevel',
|
|
'module_a.submodule.ModTopLevel.mod_child_1', 'meth')
|
|
assert_refnode(refnodes[5], 'module_b.submodule', None, 'ModTopLevel',
|
|
'class')
|
|
assert_refnode(refnodes[6], 'module_b.submodule', 'ModTopLevel',
|
|
'ModNoModule', 'class')
|
|
assert_refnode(refnodes[7], 'module_b.submodule', 'ModTopLevel',
|
|
'module_a.submodule', 'mod')
|
|
assert len(refnodes) == 8
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='domain-js')
|
|
def test_domain_js_objects(app, status, warning):
|
|
app.builder.build_all()
|
|
|
|
modules = app.env.domains['js'].data['modules']
|
|
objects = app.env.domains['js'].data['objects']
|
|
|
|
assert 'module_a.submodule' in modules
|
|
assert 'module_a.submodule' in objects
|
|
assert 'module_b.submodule' in modules
|
|
assert 'module_b.submodule' in objects
|
|
|
|
assert objects['module_a.submodule.ModTopLevel'] == ('module', 'class')
|
|
assert objects['module_a.submodule.ModTopLevel.mod_child_1'] == ('module', 'method')
|
|
assert objects['module_a.submodule.ModTopLevel.mod_child_2'] == ('module', 'method')
|
|
assert objects['ModNoModule'] == ('module', 'class')
|
|
assert objects['module_b.submodule.ModTopLevel'] == ('module', 'class')
|
|
|
|
assert objects['TopLevel'] == ('roles', 'class')
|
|
assert objects['top_level'] == ('roles', 'function')
|
|
assert objects['NestedParentA'] == ('roles', 'class')
|
|
assert objects['NestedParentA.child_1'] == ('roles', 'function')
|
|
assert objects['NestedParentA.any_child'] == ('roles', 'function')
|
|
assert objects['NestedParentA.NestedChildA'] == ('roles', 'class')
|
|
assert objects['NestedParentA.NestedChildA.subchild_1'] == ('roles', 'function')
|
|
assert objects['NestedParentA.NestedChildA.subchild_2'] == ('roles', 'function')
|
|
assert objects['NestedParentA.child_2'] == ('roles', 'function')
|
|
assert objects['NestedParentB'] == ('roles', 'class')
|
|
assert objects['NestedParentB.child_1'] == ('roles', 'function')
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='domain-js')
|
|
def test_domain_js_find_obj(app, status, warning):
|
|
|
|
def find_obj(mod_name, prefix, obj_name, obj_type, searchmode=0):
|
|
return app.env.domains['js'].find_obj(
|
|
app.env, mod_name, prefix, obj_name, obj_type, searchmode)
|
|
|
|
app.builder.build_all()
|
|
|
|
assert (find_obj(None, None, u'NONEXISTANT', u'class') ==
|
|
(None, None))
|
|
assert (find_obj(None, None, u'NestedParentA', u'class') ==
|
|
( u'NestedParentA', (u'roles', u'class')))
|
|
assert (find_obj(None, None, u'NestedParentA.NestedChildA', u'class') ==
|
|
( u'NestedParentA.NestedChildA', (u'roles', u'class')))
|
|
assert (find_obj(None, 'NestedParentA', u'NestedChildA', u'class') ==
|
|
( u'NestedParentA.NestedChildA', (u'roles', u'class')))
|
|
assert (find_obj(None, None, u'NestedParentA.NestedChildA.subchild_1', u'func') ==
|
|
( u'NestedParentA.NestedChildA.subchild_1', (u'roles', u'function')))
|
|
assert (find_obj(None, u'NestedParentA', u'NestedChildA.subchild_1', u'func') ==
|
|
( u'NestedParentA.NestedChildA.subchild_1', (u'roles', u'function')))
|
|
assert (find_obj(None, u'NestedParentA.NestedChildA', u'subchild_1', u'func') ==
|
|
( u'NestedParentA.NestedChildA.subchild_1', (u'roles', u'function')))
|
|
assert (find_obj(u'module_a.submodule', u'ModTopLevel', u'mod_child_2', u'meth') ==
|
|
( u'module_a.submodule.ModTopLevel.mod_child_2', (u'module', u'method')))
|
|
assert (find_obj(u'module_b.submodule', u'ModTopLevel', u'module_a.submodule', u'mod') ==
|
|
( u'module_a.submodule', (u'module', u'module')))
|