Python-Sphinx 文档 : link source code

Question

我有一个代表模式的字典(更准确地说是 JSON-Schema)。

有时架构会变得复杂，在文档中我需要链接到它以便提供更好的图片。

我启用了 viewcode 扩展，我尝试了以下操作，但没有成功:

.. data:: netjsonconfig.backends.openvpn.schema.schema

.. automodule:: netjsonconfig.backends.openvpn.schema

字典Python路径是netjsonconfig.backends.openvpn.schema.schema。

有可能实现这个目标吗？如果是的话怎么办？

Answer 1

试试这个:

.. literalinclude:: your_json_filename.json
    :language: json

您甚至可以选择该文件的一部分来显示

.. literalinclude:: your_json_filename.json
    :language: json
    :lines: 18-43

这将显示 your_json_filename.json 的第 18 行到 43 行。