Sphinx 文档中使用全局变量标准化链接

Question

我正在使用 Sphinx 来记录工作项目。我想在整个文档的多个页面上使用指向下载的相同链接。

例如：home.rst：

Hi
==

I want you to download_ my project.

.. _download: blah.com/download

other_page.rst

Hello Again
===========
You can also download_ it here.

.. _download: blah.com/download

有没有某种方法可以让每个页面都指向一个变量，以便当链接需要更新时仅需要更新变量？

Answer 1

最好的选择是使用替换, rst_epilog, 和raw-html如本答案中所述的 mailto 链接。

在你的conf.py：

rst_epilog = """
.. role:: raw-html(raw)
   :format: html

.. |download| replace:: :raw-html:`<a href="https://blah.com/download/">download</a>`
"""

在你的*.rst：

Please |download| my file.

该extlink扩展很接近，但假设您希望使用 URL 作为该站点其他链接的基础。