使用 ReST / Sphinx 自动生成的部分 URL 的静态别名
Static alias to auto generated section URLs with ReST / Sphinx
我有一个 Web 应用程序,其中有一些 "Help" 按钮指向我的在线文档。帮助部分的 links 在应用程序数据库中进行了硬编码。以前,文档是用HTML和JS制作的,我可以手动控制URL到该部分。
然而,现在我正在迁移到 Sphinx 和 ReST,我发现自动部分 URL 生成很棒,但无法弄清楚如何控制我的结构的这种行为。
有没有一种方法可以让 URL 别名指向我的文档的实际 URL,以便不更新应用程序数据库中的硬编码 link每次我更新 chapters/sections?
的名字时
例如:
- 我在第 1 章中有一个名为 "I like apples" 的小节。
- 我对它的硬编码 link 会是这样的
"Chapter1#I-like-apples"(我只关心#后面的部分
符号)
- 我把标题改成"I hate apples"。新的 link 将变为 "Chapter1#I-hate-apples",但在我的数据库中,我仍然需要指向同一部分的“#I-like-apples”。
请参阅 docutils 文档中的 Hyperlink Targets,特别是 "internal hyperlink targets"。
.. _my-target:
.. _synonym-to-my-target:
My Subsection
-------------
Sphinx 将为每个同义词生成目标。
您也可以做间接超链接目标。
.. _my-target: synonym-to-my-target_
.. _synonym-to-my-target:
My Subsection
-------------
我有一个 Web 应用程序,其中有一些 "Help" 按钮指向我的在线文档。帮助部分的 links 在应用程序数据库中进行了硬编码。以前,文档是用HTML和JS制作的,我可以手动控制URL到该部分。
然而,现在我正在迁移到 Sphinx 和 ReST,我发现自动部分 URL 生成很棒,但无法弄清楚如何控制我的结构的这种行为。
有没有一种方法可以让 URL 别名指向我的文档的实际 URL,以便不更新应用程序数据库中的硬编码 link每次我更新 chapters/sections?
的名字时例如:
- 我在第 1 章中有一个名为 "I like apples" 的小节。
- 我对它的硬编码 link 会是这样的 "Chapter1#I-like-apples"(我只关心#后面的部分 符号)
- 我把标题改成"I hate apples"。新的 link 将变为 "Chapter1#I-hate-apples",但在我的数据库中,我仍然需要指向同一部分的“#I-like-apples”。
请参阅 docutils 文档中的 Hyperlink Targets,特别是 "internal hyperlink targets"。
.. _my-target:
.. _synonym-to-my-target:
My Subsection
-------------
Sphinx 将为每个同义词生成目标。
您也可以做间接超链接目标。
.. _my-target: synonym-to-my-target_
.. _synonym-to-my-target:
My Subsection
-------------