可以将Sphinx设置为根据标题编号(非文本)自动创建书签吗?

问题描述 投票:0回答:1

我有一个很大的错误参考手册,该手册正在转换中,以便使用Sphinx托管在readthedocs上。我希望能够使用基于章节号(而不是标题文本)的永久书签来推荐用户,因为这是该软件的错误代码中返回的内容。我有类似的东西:

This has a chapter heading automatically numbered to give 1.
============================================================

This has a section heading automatically numbered to give 1.1
-------------------------------------------------------------

- This has no section heading as it's in a list, but is ideally 
where I want to send people using the number 1.1.1.  If that's 
too tricky, then a link to the number of the section (1.1) is fine.

我希望能够自动生成基于部分的数字,而不是其标题文本:

You got error code 1.1.1 so you need to go to:
www.mysite.readthedocs.io/blah/blah.html#bookmark1.1

有人知道是否/如何在不为每个部分手动创建自定义书签的情况下完成此任务?在此先感谢:)

PS-表示我需要知道自动编号的节号的建议将不起作用(例如:Anchor replace with '#id1' , '#id2' , '#id3' ... Sphinx]

python-sphinx restructuredtext
1个回答
0
投票

不确定我是否完全理解这些要求,但对我来说,:numref: role在这种情况下可能会有所帮助。

:numref:
.. toctree::
    :numbered:
© www.soinside.com 2019 - 2024. All rights reserved.