使用 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 来解决问题。扩展名。
他们所做的是添加对标签域数据的引用。我让它在自定义指令中工作,如下所示:
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>`
像这样:
self.env.app.env.domaindata["std"]["anonlabels"][nodeId] = self.env.docname, nodeId
关于python - 为自定义指令的节点生成标签,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64146870/