使用sphinx记录XML

Question

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

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

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

谢谢：D

Answer 1

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

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