You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

sphinx.ext.viewcode能否直接嵌入源码?附pyobject解决方案

Sphinx嵌入Python代码片段的替代方案
  • sphinx.ext.viewcode插件的核心作用是为文档里的Python对象(比如函数、类)生成跳转至源码页面的链接,不支持直接在文档页面嵌入源码片段,也无法通过引用它生成的链接路径来嵌入代码,该插件没有对应的嵌入指令。

  • 无需指定行号嵌入Python代码片段的可行方案:使用带:pyobject:参数的literalinclude指令,直接指定目标函数/类名即可精准嵌入对应源码,示例如下:

.. literalinclude :: ../../my_proj/some_path/my_module.py
   :pyobject: a_function_inside_my_module
   :linenos:
   :language: python

内容的提问来源于stack exchange,提问作者red888

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.30 22:27:05