3.4. 超链接Hyperlink Targets#
Sphinx 中支持多种格式的超链接声明。 注意 Sphinx 本身不支持在新页面打开链接的功能,要实现这个功能可以安装一个扩展 sphinx-new-tab-link , 或者使用原生 HTML 标签创建。
超链接Hyperlink 有三种:
带别名的超链接 ,语法为
.. _hyperlink-name: link-address
;由..
,空格,短下划线_
,别名,冒号,空格和链接地址构成。 在原文引用处书写语法为hyperlink-name_
(特别注意原文中"_"在别名后,而在指示链接出,"_"在别名前)。匿名anonymous的超链接,即不带别名的超链接,语法为
.. __: link-address
; 由..
,空格,两个短下划线"__",冒号,空格和链接地址构成。匿名的超链接,另一种语法形式,语法为
__ link-address
。
3.4.1. 外部链接 External Hyperlink Targets#
外部链接有两种方式,需要引用的话,使用上述带别名的超链接的语法形式,即
示例如下:
这是我的 reStructureText_ 实践笔记。
.. _reStructureText: https://sphinx-practise.readthedocs.io/zh_CN/latest/index.html
效果如下:
这是我的 reStructureText 实践笔记。
另一种是直接在名称后附加地址, 语法为 `别名 <链接>`_
示例如下:
这是我的 `reStructureText <https://sphinx-practise.readthedocs.io/zh_CN/latest/index.html>`_ 实践笔记。
效果如下:
这是我的 reStructureText 实践笔记。
3.4.2. 锚点链接 Internal Hyperlink Targets#
内部超链接,即锚点。
锚点的语法即外部超链接中 带别名的超链接 去除外部链接,其他语法一致。
3.4.3. 间接链接 Indirect Hyperlink Targets#
间接超链接是基于匿名链接的基础上的,就是将匿名链接地址换成了外部引用名。
示例如下:
Python_ is `my favourite
programming language`__.
.. _Python: http://www.python.org/
__ Python_
效果如下:
Python is my favourite programming language.
其中 python_ 就是一个正常的外部链接,而后面那句话是一个匿名链接, 对这个匿名链接使用间接链接方式链接到 Python这个外部链接的链接地址上去。
3.4.4. Implicit Hyperlink Targets#
隐式超链接
小节标题、脚注和引用参考会自动生成超链接地址,使用小节标题、脚注或引用参考名称作为超链接名称就可以生成隐式链接。
本质上它们的写法都是和 外部链接 External Hyperlink Targets 相一致的, 只是做了一些微小改动,以做出区别。
例如链接到 超链接Hyperlink Targets 这个章节目录去
`超链接Hyperlink Targets`_