Sphinx:如何自定义C++域交叉引用的链接生成规则
该需求完全可以实现,具体可通过以下两种方案操作:
方案1:废弃批量函数声明块(最简便)
你当前使用的批量.. cpp:function::声明块会自动为每个函数注册锚点,就是你现在跳转的黄色链接的来源。你可以直接删掉这个块,在你期望作为跳转目标的函数名位置,直接绑定cpp函数声明即可:
### 期望作为交叉引用目标的函数列表 :cpp:function:`status_t BDeskbar::AddItem()`, :cpp:function:`status_t BDeskbar::RemoveItem()`, :cpp:function:`status_t BDeskbar::CountItems()`, :cpp:function:`status_t BDeskbar::HasItems()`, :cpp:function:`status_t BDeskbar::GetItemInfo()` <--
此时Sphinx会直接把函数的锚点注册在你标注的位置,后续你使用:cpp:function:GetItemInfo() BDeskbar::GetItemInfo()`这类语法交叉引用时,跳转目标就会指向该位置,而非之前自动生成的条目。
方案2:保留原有批量声明块的展示内容
如果你需要保留原有批量.. cpp:function::块的文本展示,只需要给该块添加:no-index:参数,即可禁止该块自动注册锚点,仅渲染普通文本:
.. cpp:function:: :no-index: status_t BDeskbar::AddItem() status_t BDeskbar::RemoveItem() status_t BDeskbar::CountItems() status_t BDeskbar::HasItems() status_t BDeskbar::GetItemInfo()
之后在你期望作为跳转目标的位置,为每个函数单独添加锚点注册即可,添加:no-index-entry:参数可以避免重复渲染函数条目:
### 期望作为交叉引用目标的函数列表 .. cpp:function:: status_t BDeskbar::AddItem() :no-index-entry: .. cpp:function:: status_t BDeskbar::RemoveItem() :no-index-entry: .. 剩余三个函数按上述格式补充即可 AddItem(), RemoveItem(), CountItems(), HasItem(), GetItemInfo() <--
修改完成后构建HTML输出,检查你期望的目标位置的DOM ID是否为#cpp.function-BDeskbar::GetItemInfo这类格式,和交叉引用链接的href属性一致即可生效。
内容的提问来源于stack exchange,提问作者jessicah
相关产品推荐
相关产品推荐

