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

能否用含图片的手动页面覆盖Sphinx自动生成文档中的指定页面?

如何用手动编写的含图片页面替换Sphinx自动生成的文档页

完全可行,操作步骤如下:

  • 创建手动替代页面
    在你的Sphinx文档目录下,新建一个和要替换的自动生成页面同名的.rst(或.md,需启用对应markdown扩展)文件。比如要替换自动生成的my_module.rst,就直接在相同路径下创建同名文件,编写你的自定义内容,包括插入图片:

    .. image:: _static/my_diagram.png
       :alt: 模块流程示意图
       :width: 700px
    

    建议把图片放在文档目录的_static子文件夹下,路径更规范,也符合Sphinx的默认资源查找规则。

  • 避免自动生成工具覆盖手动文件
    如果你之前用sphinx-apidoc批量生成模块文档,后续再运行该命令时,默认会覆盖同名的.rst文件。可以添加--no-overwrite参数,让命令跳过已存在的文件;或者直接把手动创建的页面放在自动生成文件的目录外,再调整索引的toctree指向它。

  • 调整文档索引的toctree结构
    打开你的主索引文件(一般是index.rst),找到对应的toctree条目,确保它指向的是你手动创建的页面路径,而不是原来自动生成的文件。比如原来的条目是modules/my_module,如果手动文件放在根目录,就改成my_module。

  • 构建验证
    运行make html(Windows环境用.\make.bat html)重新构建文档,打开生成的HTML文件,确认手动页面已经替换了自动生成的内容,图片正常加载显示。

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.06.12 19:18:15