微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

自动从标签和引用生成索引

如何解决自动从标签和引用生成索引

是否可以让Sphinx根据现有标签和文本中的:ref:生成索引?假设您有标签

.. _my_label:

My Section 

,然后通过多个:ref:`my_label` 对其进行引用,有没有一种方法可以等效于自动生成

.. index:: My Section

标签在哪里,与:ref:所在的段落前面的标签一样?

官方文档未将标签:ref:列为index-generating markup,但我找不到任何扩展名。但是也许有一个

解决方法

有一个Sphinx extensions的官方列表,在Github上有一些非官方的扩展名,但是没有一个实现问题中指定的功能。

与问题中指定问题最接近的方法是使用autosectionlabel自动创建具有节名称的目标标签,并将:index:.. index::放置在reST旁边部分将其放置在索引中。但是,这样只会省去声明标签的必要,而仍然需要声明索引条目。

您所要求的功能(指令)除了为段或目标编写代码之外,几乎不需要写一行或一部分reST代码(.. index::指令或:index:角色),几乎没有明显的收益。 / p>

Sphinx是开源的,因此可以实现自定义指令,但是,使用仅以单个结构缩短标准语法为目标的非标准指令将给获取源代码的读者带来更多的困难,而不是获得收益。 / p>

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。