Add tests for C domain

Author: TLouf

tests/roots/test-domain-c-c_maximum_signature_line_length/conf.py

@@ -0,0 +1 @@
+c_maximum_signature_line_length = len("str hello(str name)") - 1

tests/roots/test-domain-c-c_maximum_signature_line_length/index.rst

@@ -0,0 +1,4 @@
+domain-c-c_maximum_signature_line_length
+========================================
+
+.. c:function:: str hello(str name)

tests/test_domain_c.py

@@ -5,9 +5,13 @@
 from xml.etree import ElementTree
 
 import pytest
+from docutils import nodes
 
 from sphinx import addnodes
-from sphinx.addnodes import desc
+from sphinx.addnodes import (desc, desc_name, desc_content, desc_parameter,
+                             desc_parameter_line, desc_parameterlist, desc_sig_name,
+                             desc_sig_space, desc_signature, desc_signature_line,
+                             pending_xref)
 from sphinx.domains.c import (DefinitionError, DefinitionParser, Symbol, _id_prefix,
                               _macroKeywords, _max_id)
 from sphinx.ext.intersphinx import load_mappings, normalize_intersphinx_mapping
@@ -808,3 +812,68 @@ def test_domain_c_parse_noindexentry(app):
     assert_node(doctree, (addnodes.index, desc, addnodes.index, desc))
     assert_node(doctree[0], addnodes.index, entries=[('single', 'f (C function)', 'c.f', '', None)])
     assert_node(doctree[2], addnodes.index, entries=[])
+
+
+@pytest.mark.sphinx(
+    'html',
+    confoverrides={'c_maximum_signature_line_length': len("str hello(str name)")}
+)
+def test_cfunction_signature_with_c_maximum_signature_line_length(app):
+    text = ".. c:function:: str hello(str name)"
+    doctree = restructuredtext.parse(app, text)
+    expected_doctree = (
+        addnodes.index,
+        [desc, ([desc_signature, ([desc_signature_line, (pending_xref,
+                                                         desc_sig_space,
+                                                         [desc_name, [desc_sig_name, "hello"]],
+                                                         desc_parameterlist)])],
+                desc_content)]
+    )
+    assert_node(doctree, expected_doctree)
+    assert_node(doctree[1], addnodes.desc, desctype="function",
+                domain="c", objtype="function", noindex=False)
+    signame_node = [desc_sig_name, "name"]
+    expected_sig = [desc_parameterlist, desc_parameter, ([pending_xref, [desc_sig_name, "str"]],
+                                                         desc_sig_space,
+                                                         signame_node)]
+    assert_node(doctree[1][0][0][3], expected_sig)
+    
+    text = (".. c:function:: str hello(str names)\n"
+            "   :single-line-signature:")
+    signame_node[1] = "names"
+    doctree = restructuredtext.parse(app, text)
+    assert_node(doctree, expected_doctree)
+    assert_node(doctree[1], addnodes.desc, desctype="function",
+                domain="c", objtype="function", noindex=False)
+    assert_node(doctree[1][0][0][3], expected_sig)
+
+    text = ".. c:function:: str hello(str names)"
+    doctree = restructuredtext.parse(app, text)
+    expected_sig.insert(1, desc_parameter_line)
+    assert_node(doctree, expected_doctree)
+    assert_node(doctree[1], addnodes.desc, desctype="function",
+                domain="c", objtype="function", noindex=False)
+    assert_node(doctree[1][0][0][3], expected_sig)
+
+
+@pytest.mark.sphinx(
+    'html', testroot='domain-c-c_maximum_signature_line_length',
+)
+def test_domain_c_c_maximum_signature_line_length(app, status, warning):
+    app.build()
+    content = (app.outdir / 'index.html').read_text(encoding='utf8')
+    expected = '\n'.join((
+        '<dl>',
+        (
+            '<dd><span class="n"><span class="pre">str</span></span><span class="w"> </span>'
+            '<span class="n"><span class="pre">name</span></span>, </dd>'
+        ),
+        '</dl>',
+        '',
+        (
+            '<span class="sig-paren">)</span>'
+            '<a class="headerlink" href="#c.hello" title="Permalink to this definition">¶</a>'
+            '<br /></dt>'
+        ),
+    ))
+    assert expected in content