Python-Sphinx文档:链接源代码

时间:2016-09-05 10:19:33

标签: python python-sphinx

我有一个代表架构的字典(JSON-Schema更精确)。

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

我已启用viewcode扩展程序,我尝试了以下操作但没有运气:

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

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

字典python路径为netjsonconfig.backends.openvpn.schema.schema

有可能实现这一目标吗?如果是的话怎么样?

1 个答案:

答案 0 :(得分:0)

试试这个:

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

您甚至可以通过

选择要显示的此文件的一部分
.. literalinclude:: your_json_filename.json
    :language: json
    :lines: 18-43

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