""" test_domain_std ~~~~~~~~~~~~~~~ Tests the std domain :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from unittest import mock from docutils import nodes from docutils.nodes import definition, definition_list, definition_list_item, term from sphinx.addnodes import glossary, index from sphinx.domains.std import StandardDomain from sphinx.testing import restructuredtext from sphinx.testing.util import assert_node def test_process_doc_handle_figure_caption(): env = mock.Mock(domaindata={}) env.app.registry.enumerable_nodes = {} figure_node = nodes.figure( '', nodes.caption('caption text', 'caption text'), ) document = mock.Mock( nametypes={'testname': True}, nameids={'testname': 'testid'}, ids={'testid': figure_node}, citation_refs={}, ) document.traverse.return_value = [] domain = StandardDomain(env) if 'testname' in domain.data['labels']: del domain.data['labels']['testname'] domain.process_doc(env, 'testdoc', document) assert 'testname' in domain.data['labels'] assert domain.data['labels']['testname'] == ( 'testdoc', 'testid', 'caption text') def test_process_doc_handle_table_title(): env = mock.Mock(domaindata={}) env.app.registry.enumerable_nodes = {} table_node = nodes.table( '', nodes.title('title text', 'title text'), ) document = mock.Mock( nametypes={'testname': True}, nameids={'testname': 'testid'}, ids={'testid': table_node}, citation_refs={}, ) document.traverse.return_value = [] domain = StandardDomain(env) if 'testname' in domain.data['labels']: del domain.data['labels']['testname'] domain.process_doc(env, 'testdoc', document) assert 'testname' in domain.data['labels'] assert domain.data['labels']['testname'] == ( 'testdoc', 'testid', 'title text') def test_get_full_qualified_name(): env = mock.Mock(domaindata={}) env.app.registry.enumerable_nodes = {} domain = StandardDomain(env) # normal references node = nodes.reference() assert domain.get_full_qualified_name(node) is None # simple reference to options node = nodes.reference(reftype='option', reftarget='-l') assert domain.get_full_qualified_name(node) is None # options with std:program context kwargs = {'std:program': 'ls'} node = nodes.reference(reftype='option', reftarget='-l', **kwargs) assert domain.get_full_qualified_name(node) == 'ls.-l' def test_glossary(app): text = (".. glossary::\n" "\n" " term1\n" " term2\n" " description\n" "\n" " term3 : classifier\n" " description\n" " description\n" "\n" " term4 : class1 : class2\n" " description\n") # doctree doctree = restructuredtext.parse(app, text) assert_node(doctree, ( [glossary, definition_list, ([definition_list_item, ([term, ("term1", index)], [term, ("term2", index)], definition)], [definition_list_item, ([term, ("term3", index)], definition)], [definition_list_item, ([term, ("term4", index)], definition)])], )) assert_node(doctree[0][0][0][0][1], entries=[("single", "term1", "term-term1", "main", None)]) assert_node(doctree[0][0][0][1][1], entries=[("single", "term2", "term-term2", "main", None)]) assert_node(doctree[0][0][0][2], [definition, nodes.paragraph, "description"]) assert_node(doctree[0][0][1][0][1], entries=[("single", "term3", "term-term3", "main", "classifier")]) assert_node(doctree[0][0][1][1], [definition, nodes.paragraph, ("description\n" "description")]) assert_node(doctree[0][0][2][0][1], entries=[("single", "term4", "term-term4", "main", "class1")]) assert_node(doctree[0][0][2][1], [nodes.definition, nodes.paragraph, "description"]) # index objects = list(app.env.get_domain("std").get_objects()) assert ("term1", "term1", "term", "index", "term-term1", -1) in objects assert ("term2", "term2", "term", "index", "term-term2", -1) in objects assert ("term3", "term3", "term", "index", "term-term3", -1) in objects assert ("term4", "term4", "term", "index", "term-term4", -1) in objects def test_glossary_warning(app, status, warning): # empty line between terms text = (".. glossary::\n" "\n" " term1\n" "\n" " term2\n") restructuredtext.parse(app, text, "case1") assert ("case1.rst:4: WARNING: glossary terms must not be separated by empty lines" in warning.getvalue()) # glossary starts with indented item text = (".. glossary::\n" "\n" " description\n" " term\n") restructuredtext.parse(app, text, "case2") assert ("case2.rst:3: WARNING: glossary term must be preceded by empty line" in warning.getvalue()) # empty line between terms text = (".. glossary::\n" "\n" " term1\n" " description\n" " term2\n") restructuredtext.parse(app, text, "case3") assert ("case3.rst:4: WARNING: glossary term must be preceded by empty line" in warning.getvalue()) def test_glossary_comment(app): text = (".. glossary::\n" "\n" " term1\n" " description\n" " .. term2\n" " description\n" " description\n") doctree = restructuredtext.parse(app, text) assert_node(doctree, ( [glossary, definition_list, definition_list_item, ([term, ("term1", index)], definition)], )) assert_node(doctree[0][0][0][1], [nodes.definition, nodes.paragraph, "description"]) def test_glossary_comment2(app): text = (".. glossary::\n" "\n" " term1\n" " description\n" "\n" " .. term2\n" " term3\n" " description\n" " description\n") doctree = restructuredtext.parse(app, text) assert_node(doctree, ( [glossary, definition_list, ([definition_list_item, ([term, ("term1", index)], definition)], [definition_list_item, ([term, ("term3", index)], definition)])], )) assert_node(doctree[0][0][0][1], [nodes.definition, nodes.paragraph, "description"]) assert_node(doctree[0][0][1][1], [nodes.definition, nodes.paragraph, ("description\n" "description")]) def test_glossary_sorted(app): text = (".. glossary::\n" " :sorted:\n" "\n" " term3\n" " description\n" "\n" " term2\n" " term1\n" " description\n") doctree = restructuredtext.parse(app, text) assert_node(doctree, ( [glossary, definition_list, ([definition_list_item, ([term, ("term2", index)], [term, ("term1", index)], definition)], [definition_list_item, ([term, ("term3", index)], definition)])], )) assert_node(doctree[0][0][0][2], [nodes.definition, nodes.paragraph, "description"]) assert_node(doctree[0][0][1][1], [nodes.definition, nodes.paragraph, "description"])