IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove JS domain module feature for null module names

Browse Source
This commit is contained in:
Anthony Johnson 2017-03-20 13:38:23 -07:00
parent 5d8b49d221
commit fb3953698b
No known key found for this signature in database
GPG Key ID: C5C79D82F922D604
3 changed files with 2 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sphinx/domains/javascript.py
View File

@ -236,8 +236,7 @@ class JSModule(Directive):
is useful for splitting up the module definition across multiple is useful for splitting up the module definition across multiple
sections or files. sections or files.
:param mod_name: Module name. If the module name is ``nul``, or ``None``, :param mod_name: Module name
the module name will be cleared for objects that follow.
""" """
has_content = False has_content = False
@ -252,9 +251,6 @@ class JSModule(Directive):
# type: () -> List[nodes.Node] # type: () -> List[nodes.Node]
env = self.state.document.settings.env env = self.state.document.settings.env
mod_name = self.arguments[0].strip() mod_name = self.arguments[0].strip()
if mod_name in ['null', 'None']:
env.ref_context.pop('js:module', None)
return []
env.ref_context['js:module'] = mod_name env.ref_context['js:module'] = mod_name
noindex = 'noindex' in self.options noindex = 'noindex' in self.options
ret = [] ret = []

6
tests/roots/test-domain-js/module.rst
View File

@ -18,16 +18,10 @@ module
* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1` * Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`
.. js:module:: null
:noindex:
.. js:class:: ModNoModule
.. js:module:: module_b.submodule .. js:module:: module_b.submodule
* Link to :js:class:`ModTopLevel` * Link to :js:class:`ModTopLevel`
.. js:class:: ModTopLevel .. js:class:: ModTopLevel
* Link to :js:class:`ModNoModule`
* Link to :js:mod:`module_a.submodule` * Link to :js:mod:`module_a.submodule`

5
tests/test_domain_js.py
View File

@ -72,10 +72,8 @@ def test_domain_js_xrefs(app, status, warning):
assert_refnode(refnodes[5], 'module_b.submodule', None, 'ModTopLevel', assert_refnode(refnodes[5], 'module_b.submodule', None, 'ModTopLevel',
'class') 'class')
assert_refnode(refnodes[6], 'module_b.submodule', 'ModTopLevel', assert_refnode(refnodes[6], 'module_b.submodule', 'ModTopLevel',
'ModNoModule', 'class')
assert_refnode(refnodes[7], 'module_b.submodule', 'ModTopLevel',
'module_a.submodule', 'mod') 'module_a.submodule', 'mod')
assert len(refnodes) == 8 assert len(refnodes) == 7
@pytest.mark.sphinx('dummy', testroot='domain-js') @pytest.mark.sphinx('dummy', testroot='domain-js')
@ -93,7 +91,6 @@ def test_domain_js_objects(app, status, warning):
assert objects['module_a.submodule.ModTopLevel'] == ('module', 'class') 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_1'] == ('module', 'method')
assert objects['module_a.submodule.ModTopLevel.mod_child_2'] == ('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['module_b.submodule.ModTopLevel'] == ('module', 'class')
assert objects['TopLevel'] == ('roles', 'class') assert objects['TopLevel'] == ('roles', 'class')