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

问题描述

使用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]

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

.. todolist::

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

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

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

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

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)