Method add_enumerable_node

sphinx/application.py:1030–1064

Register a Docutils node class as a numfig target. Sphinx numbers the node automatically. And then the users can refer it using :rst:role:`numref`. :param node: A node class :param figtype: The type of enumerable nodes. Each figtype has individual numbering

(
        self,
        node: type[Element],
        figtype: str,
        title_getter: TitleGetter | None = None,
        override: bool = False,
        **kwargs: tuple[_NodeHandler, _NodeHandler],
    )

        self.registry.add_translation_handlers(node, **kwargs)

    def add_enumerable_node(
        self,
        node: type[Element],
        figtype: str,
        title_getter: TitleGetter | None = None,
        override: bool = False,
        **kwargs: tuple[_NodeHandler, _NodeHandler],
    ) -> None:
        """Register a Docutils node class as a numfig target.

        Sphinx numbers the node automatically. And then the users can refer it
        using :rst:role:`numref`.

        :param node: A node class
        :param figtype: The type of enumerable nodes.  Each figtype has individual numbering
                        sequences.  As system figtypes, ``figure``, ``table`` and
                        ``code-block`` are defined.  It is possible to add custom nodes to
                        these default figtypes.  It is also possible to define new custom
                        figtype if a new figtype is given.
        :param title_getter: A getter function to obtain the title of node.  It takes an
                             instance of the enumerable node, and it must return its title as
                             string.  The title is used to the default title of references for
                             :rst:role:`ref`.  By default, Sphinx searches
                             ``docutils.nodes.caption`` or ``docutils.nodes.title`` from the
                             node as a title.
        :param kwargs: Visitor functions for each builder (same as :meth:`add_node`)
        :param override: If true, install the node forcedly even if another node is already
                         installed as the same name

        .. versionadded:: 1.4
        """
        self.registry.add_enumerable_node(
            node, figtype, title_getter, override=override
        )
        self.add_node(node, override=override, **kwargs)

    def add_directive(
        self, name: str, cls: type[Directive], override: bool = False