关于Sphinx 1.4术语表索引键experimental标注相关问题咨询
术语表索引键标记为experimental的触发场景
所有被标记为实验性的索引键相关场景均为1.4版本引入该特性时,旧索引器存在的功能缺陷场景,具体包括三类:
- 增量构建缓存不一致场景:旧索引器不会在术语表内容更新后自动失效索引缓存,必须执行
make clean清除旧缓存后重新构建,才会在genindex.html生成正确的索引条目,这是该特性最早被标记为实验性的核心原因。 - 多域索引键冲突场景:不同文档域(如Python域、C/C++域)生成的索引键存在命名冲突,自定义索引分类器规则和默认索引拆分逻辑不兼容,旧索引器处理这类情况时输出结果不稳定。
- 特殊索引条目格式兼容场景:包含
see/seealso交叉引用的索引条目、不同模块下的同名函数/变量等同名索引条目,旧版本没有统一的键值生成规范,不同输出格式(HTML、EPUB、PDF)生成的索引键值不一致,无法保证多端索引跳转的准确性。
修复验证说明
提交的测试用例已经完整覆盖了上述三类问题场景,所有用例测试通过说明使用的新索引器已经修复了已知的所有索引键实验性问题,现有场景下可稳定使用。
内容的提问来源于stack exchange,提问作者KaKkouo
相关产品推荐
相关产品推荐

