2

我是sphinx-needs的维护者，它允许定义需求、错误、......

这些对象存储在相关的指令运行函数中，我最终在我的 sphinx 文档中获得了所有对象的列表。

这些对象可以相互链接，我想创建这些链接的图表（使用 plantuml 和相关的 sphinx-plantuml 扩展）。

问题是，我不知道如何让 sphinx 添加和重新呈现动态创建的植物图规范。

在指令中，我可以使用 state_machine 来完成这项工作：

diagram = generate_plantuml_spec(objects)
self.state_machine.insert_input(
        diagram.split('\n'),
        self.state_machine.document.attributes['source'])

但那是错误的地方，因为我的扩展尚未收集所有对象。

因此，正确的位置应该在函数内部，当 sphinx 触发事件“doctree-resolved”时执行该函数。

在这个函数中，我可以添加任何类型的 docutils 节点。我的想法是使用生成的图表规范创建一个 node.Text()

 def process_needfilters(app, doctree, fromdocname):
     diagram_data = """"
                    .. plantuml::

                       @startuml
                       node Test
                       @enduml
                    """
     for node in doctree.traverse(needs_diagram):
         content = []
         diagram = nodes.Text(diagram_data, diagram_data)
         content.append(diagram)
         node.replace_self(content)

但是，这不会强制 sphinx 呈现内容。

我还发现了一个名为nested_pa​​rse_with_titles()的 sphinx 函数，但这需要一个“状态”对象，该对象只能在指令内部使用，而不能在事件处理程序内部使用。

那么，知道如何在 sphinx 事件处理程序中呈现第一个内容吗？

4

1 回答 1

0

解决方案是直接使用plantuml-extension中的plantuml节点：

sphinx-needs 的简化代码片段：

from sphinxcontrib.plantuml import plantuml

for node in doctree.traverse(MyDirective):
    plantuml_block_text = ".. plantuml::\n" \
                          "\n" \
                          "   @startuml" \
                          "   @enduml"
    puml_node = plantuml(plantuml_block_text, **dict())
    node.replace_self(puml_node)
于 2017-08-30T06:48:56.090 回答