首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >将代码类型传递给Sphinx `..include::`指令

将代码类型传递给Sphinx `..include::`指令
EN

Stack Overflow用户
提问于 2021-08-27 15:04:57
回答 1查看 35关注 0票数 0

我想在Sphinx文档中包含完整的示例脚本。我最初只是使用.. code::指令复制了一个示例文件,删除了示例的整个python和json文件。

然后我找到了.. include::指令,它允许通过提供文件的相对路径和使用code选项"The argument and the included content are passed to the code directive“来链接到文件。这对我的python文件很有效,因为code指令的默认解码和高亮显示是python。但是我的json文件没有突出显示为json。如何指示代码指令应该使用什么代码格式来解析代码?

这就是我正在使用的。

代码语言:javascript
运行
复制
.. include:: ../../examples/my_example.json
    :code:

我尝试将第二行更改为:code: json,但没有任何效果。

这是我最初拥有的,但我希望替换它,这样示例代码就不需要在文档和示例中维护。

代码语言:javascript
运行
复制
.. code-block:: json
    :name: my_example.json
    :caption: my_example.json

    {
        "field1": "attribute1",
        "field2": "attribute2",
        "field3": true,
        ...
    }
EN

回答 1

Stack Overflow用户

发布于 2021-08-27 19:38:34

解决方案是使用具有language选项的literalinclude directive。这是它应该看起来的样子。

代码语言:javascript
运行
复制
.. literalinclude:: ../../examples/my_example.json
    :language: json

请注意,文本包含还支持linenoslinesstart-afterend-beforecaptionname等选项。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/68955651

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档