Fix #1858: Support numbering custom nodes

tests/roots/test-add_enumerable_node/index.rst

@@ -21,6 +21,14 @@ First section
 
    First my figure
 
+.. _first_numbered_text:
+
+.. numbered-text:: Hello world
+
+.. _second_numbered_text:
+
+.. numbered-text:: Hello Sphinx
+
 Second section
 ==============
 
@@ -36,3 +44,5 @@ Reference section
 * first_figure is :numref:`first_figure`
 * first_my_figure is :numref:`first_my_figure`
 * second_my_figure is :numref:`second_my_figure`
+* first numbered_text is :numref:`first_numbered_text`
+* second numbered_text is :numref:`second_numbered_text`

tests/roots/test-add_enumerable_node/test_enumerable_node.py

@@ -28,8 +28,38 @@ class MyFigure(Directive):
         return [figure_node]
 
 
+class numbered_text(nodes.Element):
+    pass
+
+
+def visit_numbered_text(self, node):
+    self.body.append(self.starttag(node, 'div'))
+    self.add_fignumber(node)
+    self.body.append(node['title'])
+    self.body.append('</div>')
+    raise nodes.SkipNode
+
+
+def get_title(node):
+    return node['title']
+
+
+class NumberedText(Directive):
+    required_arguments = 1
+    final_argument_whitespace = True
+
+    def run(self):
+        return [numbered_text(title=self.arguments[0])]
+
+
 def setup(app):
     # my-figure
     app.add_enumerable_node(my_figure, 'figure',
                             html=(visit_my_figure, depart_my_figure))
     app.add_directive('my-figure', MyFigure)
+
+    # numbered_label
+    app.add_enumerable_node(numbered_text, 'original', get_title,
+                            html=(visit_numbered_text, None))
+    app.add_directive('numbered-text', NumberedText)
+    app.config.numfig_format.setdefault('original', 'No.%s')

tests/test_build_html.py

@@ -953,9 +953,13 @@ def test_enumerable_node(app, status, warning):
              "Fig. 2", True),
             (".//div[@class='figure']/p[@class='caption']/span[@class='caption-number']",
              "Fig. 3", True),
+            (".//div//span[@class='caption-number']", "No.1 ", True),
+            (".//div//span[@class='caption-number']", "No.2 ", True),
             (".//li/a/span", 'Fig. 1', True),
             (".//li/a/span", 'Fig. 2', True),
             (".//li/a/span", 'Fig. 3', True),
+            (".//li/a/span", 'No.1', True),
+            (".//li/a/span", 'No.2', True),
         ],
     }