用 sphinx 记录 XML [关闭]

Question

我有一个 python 项目，我正在用 sphinx 记录它。该项目读入一个 xml 配置文件。记录此配置文件的最佳方法是什么？我可以以某种方式包含一个 xml 架构吗？或者有一个很好的级联示例？我知道我可以直接打出来，但有没有更好的方法让它看起来漂亮且易于编写/维护？

我发现的只是在狮身人面像中包含 xml 以更改结构等的方法。

我正在寻找一种高度集成且易于使用的方法。

谢谢:D

Answer 1

this question 的答案建议使用 Sphinx 的 literalinclude 指令。

这将允许您包含可以使用标准 XML 注释字符串 <!-- --> 记录的 XML 文件的文字内容。该指令允许您指定可能会影响最终呈现的内容的语言。