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

时间:2019-08-08 17:22:04

标签: python-sphinx restructuredtext

我正在使用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

是否有某种方法可以使每个页面指向一个变量,所以当链接仅需要更新变量时需要更新?

1 个答案:

答案 0 :(得分:1)

最好的选择是使用substitution中所述的rst_epiloganswer for mailto linksraw-html

在您的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 extension已经结束,但是假设您将要使用URL作为指向该站点其他链接的基础。