ReST / Sphinx - 自动生成的部分URL的静态别名

时间:2017-10-02 08:41:47

标签: url documentation url-routing python-sphinx restructuredtext

我有一个带有“帮助”按钮的Web应用程序,它指向我的在线文档。指向帮助部分的链接在应用程序数据库中进行了硬编码。以前,文档是用HTML和JS编写的,我可以手动控制该部分的URL。

但是,现在我正在迁移到Sphinx和ReST,我发现自动部分URL生成很好,但无法弄清楚如何控制我的结构的这种行为。

有没有办法有一种URL别名指向我的文档的实际URL,以便每次更新我的章节/部分的名称时不更新app db中的硬编码链接?

例如:

  • 我在第1章中有一个名为“我喜欢苹果”的小节。
  • 我的硬编码链接就像是 “第1章#我喜欢苹果”(我只关心#之后的部分 签)
  • 我将标题改为“我讨厌苹果”。新链接将成为“第1章#I-hate-apples”,但在我的数据库中,我仍然需要“#I-like-apples”指向同一部​​分。

1 个答案:

答案 0 :(得分:3)

请参阅docutils文档中的Hyperlink Targets,特别是“内部超链接目标”。

.. _my-target:
.. _synonym-to-my-target:

My Subsection
-------------

Sphinx将为每个同义词生成目标。

您也可以进行间接超链接目标。

.. _my-target: synonym-to-my-target_
.. _synonym-to-my-target:

My Subsection
-------------