在.rst文件中插入行内图标失败的问题咨询
问题根因
你使用的|icon-xxx|语法是reStructuredText的替换引用规则,本身无法自动匹配同目录下的图片文件名。之前|icon-copy|可正常渲染,是因为项目内已经预先定义了该替换名和studio_icon_copy图片的映射关系,你新增图片后没有补充对应的替换定义,才会导致渲染失败。
解决步骤
- 找到替换规则的存放位置,现有
icon-copy的规则有两种常见存放路径:- 仅当前文档生效:定义在当前.rst文件的头部或末尾,参考格式如下:
.. |icon-copy| image:: studio_icon_copy.png :height: 1em :width: 1em- 全项目文档生效:定义在项目Sphinx配置文件的
rst_epilog参数中,用于统一管理所有全局替换规则
- 照着现有
icon-copy的规则,新增icon-additional的映射,注意图片文件名、后缀要和你实际存放的文件完全一致:.. |icon-additional| image:: studio_icon_additional.png :height: 1em :width: 1em - 提交修改后的配置文件/ rst文件、以及新增的图片文件到GitHub,重新触发文档构建即可生效。
注意事项
- GitHub使用的Linux文件系统大小写敏感,要确认文件名大小写和定义中的写法完全匹配,避免本地测试正常、线上渲染失败的问题
- 如果找不到现有替换规则的位置,可以全局搜索项目内所有文件的
|icon-copy|关键字,就能定位到定义位置
内容的提问来源于stack exchange,提问作者techwriter
相关产品推荐
相关产品推荐

