python - 如何打印 sphinx 项目中定义的所有标签？

Question

我想打印项目中所有 sphinx 文档中定义的所有标签的列表，包括我像这样手动定义的标签

.. _mylabel:

还有 sphinx 自动生成的标签，例如:ref:`genindex` 和:ref:`search`。

对于大型项目，我经常忘记如何拼写某些标签(我是否称其为“examples”、“Examples”或“sect-examples”？)。如果我可以打印出任何文件中定义的所有标签，那么每次我想要引用某些内容时，我就可以查看该列表并识别名称，而无需检查单个文件。

Answer 1

当 sphinx 运行时，它将有关其解析的文档的信息保存在名为 environmment.pickle 的文件中。这包括项目中定义的所有引用的标签，包括第一个文件中显式的以及运行 sphinx 时自动设置的标签。这是按域排序的。以下是我在“标准域”(std) 中查找所有标签的方法:

import cPickle
dat = cPickle.load(file('environment.pickle'))
dat.domaindata['std']['labels'].keys()

这对于其他 sphinx 域同样有效。您将看到标签 modindex (用于 python 模块索引)始终被定义，即使未生成模块索引(指向此的链接将失效)。

Sphinx 仅定义了很少的标签(search、genindex、modindex)，因此此处所述的方法回答了我原来的问题，但是可能只对调试 sphinx 扩展有用。