为自定义指令的节点生成标签

如何解决为自定义指令的节点生成标签

使用Sphinx "TODO" Directive example，我想引用嵌入在.rst文件中的todo实例。例如，如果.rst文件内容包含：

.. todo:: foo

.. todo:: bar

我可以看到以下代码（摘自Sphinx Todo示例页面）

class TodoDirective(SphinxDirective):

    # this enables content in the directive
    has_content = True

    def run(self):
        targetid = 'todo-%d' % self.env.new_serialno('todo')
        targetnode = nodes.target('','',ids=[targetid])

        todo_node = todo('\n'.join(self.content))
        todo_node += nodes.title(_('Todo'),_('Todo'))
        self.state.nested_parse(self.content,self.content_offset,todo_node)

        if not hasattr(self.env,'todo_all_todos'):
            self.env.todo_all_todos = []

        self.env.todo_all_todos.append({
            'docname': self.env.docname,'lineno': self.lineno,'todo': todo_node.deepcopy(),'target': targetnode,})

        return [targetnode,todo_node]

使用ids：todo-0和todo-1创建目标节点。 通过将指令嵌入到.rst文件中，可以成功引用该引用：

.. todolist::

我想做的是引用.rst文件中的todo项，如下所示：

:ref:`todo-0`
:ref:`todo-1`

这将需要获取TodoDirective才能为每个目标节点生成标签。我还无法弄清楚该怎么做。

这个简单的项目发布在这里：https://github.com/natersoz/sphinx_sandbox

解决方法

我遇到了与您相同的问题，通过查看autosectionlabel扩展名就能解决此问题。

他们在那里要做的是将引用添加到标签域数据。我可以在这样的自定义指令中使用它：

python search_yaml.py servername

键是上面代码的第二行。

您还希望将标签添加到nodeId = nodes.make_id("some-id") self.env.app.env.domaindata["std"]["labels"][nodeId] = self.env.docname,nodeId,"Title" section = nodes.section(ids=[nodeId]) section.append(nodes.title(text="Title")) 以便能够通过

进行引用

anonlabels

像这样：

:ref:`foo <nodeId>`

,

我找到了执行此操作的一种方法。它可能仅适用于HTML输出：

showInfo()

此参考链接将成功链接到TODO。 所有其他参考尝试均失败。即这些都失败了：

`Text related to todo-0 <introduction.html#todo-0>`_