Documenting XML with sphinx
我有一个用 sphinx 记录的 Python 项目。该项目读入一个 xml 配置文件。记录此配置文件的最佳方式是什么?我可以以某种方式包含一个 xml 模式吗?或者有一个很好的级联示例?我知道我可以直接输入它,但是有没有更好的方法让它看起来漂亮且易于编写/维护?
我发现的只是在 sphinx 中包含 xml 以更改结构等的方法
我正在寻找一种高度集成且易于使用的方法。
谢谢:D
这个问题的答案建议使用 Sphinx\\'s literalinclude 指令。
这将允许您包含 XML 文件的文字内容,您可以使用标准 XML 注释字符串