mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix #1858: Support numbering custom nodes
This commit is contained in:
@@ -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`
|
||||
|
||||
@@ -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')
|
||||
|
||||
Reference in New Issue
Block a user