Skip to main content
Ctrl+K
Sphinx文档管理 - Home
  • 1. 引言
    • 1.1. 文档与文档管理
    • 1.2. 文档在软件开发中的作用
    • 1.3. 软件技术文档代码化现象
    • 1.4. 文档代码化重塑软件开发
    • 1.5. 文档制作工具Sphinx简介
  • 2. 使用Sphinx进行文档组织
    • 2.1. 安装与使用Sphinx
    • 2.2. Sphinx配置
    • 2.3. Sphinx构建
    • 2.4. 编辑 reStructuredText
    • 2.5. Sphinx重要扩展介绍
    • 2.6. 常见问题集锦
    • 2.7. 第一个 Sphinx 项目
    • 2.8. 支持的语法比较
  • 3. reStructuredText 标识语法
    • 3.1. ReST 文档结构语法
    • 3.2. ReST 行内文本常用语法
    • 3.3. 列表表示语法
    • 3.4. 超链接Hyperlink Targets
    • 3.5. Rest文本块
    • 3.6. 特殊提示
    • 3.7. 代码高亮
    • 3.8. 添加图片
    • 3.9. 表格
    • 3.10. 使用数学表达式
  • 4. Sphinx中的角色与指令
    • 4.1. Sphinx中角色和指令语法
    • 4.2. 交叉引用
    • 4.3. 脚注 Footnotes
    • 4.4. 引文(文献引用)
    • 4.5. 术语引用
    • 4.6. Sphinx+reStructuredText:变量的使用
  • 5. MyST扩展
    • 5.1. 为什么使用 MyST
    • 5.2. 在Sphinx中使用 MyST
    • 5.3. MyST 中的指令与角色
    • 5.4. 可选的 MyST 扩展语法
    • 5.5. MyST 与 Sphinx
    • 5.6. MyST-NB
  • 6. Sphinx 扩展模块
    • 6.1. 数学表达式渲染方式
    • 6.2. 使用Graphviz绘图
    • 6.3. 使用PlantUML绘图
    • 6.4. autosectionlabel
    • 6.5. sphinx.ext.todo
    • 6.6. 下拉框插件 sphinx-togglebutton
    • 6.7. 选项卡插件 sphinx_tabs.tabs
  • 7. Sphinx常用相关工具
    • 7.1. sphinx-autobuild
    • 7.2. RST-to-MyST
    • 7.3. API手册制作指南
    • 7.4. Sphinx中的国际化
    • 7.5. Sphinx 生成 PDF
    • 7.6. Sphinx中功能的扩展开发
    • 7.7. Sphinx-Multiversion 使用教程
  • 8. 工具链与技术栈
    • 8.1. Linux Shell 文本处理工具
    • 8.2. 版本控制系统Git教程
    • 8.3. Sphinx 协作开发
    • 8.4. Make工具介绍
    • 8.5. 使用Pandoc进行文档转换
    • 8.6. 发布网站到GitHub
    • 8.7. 发布静态网站
    • 8.8. Sphinx 文档发布
  • 9. Sphinx Design扩展模块介绍
    • 9.1. 安装与配置
    • 9.2. 网格
    • 9.3. 卡片
    • 9.4. 可下拉选项卡
    • 9.5. 标签选项卡
    • 9.6. 徽章,按钮和图标
    • 9.7. 附加
    • 9.8. 样式
  • 10. Jupyter Book文档管理与构建
    • 10.1. Jupyter Book 使用教程
    • 10.2. Jupyter Book 使用与配置指南
    • 10.3. JupyterLab 概述
    • 10.4. 开始使用
    • 10.5. 配置项和目录
    • 10.6. 一些语法说明
  • 11. 使用Sphinx主题样式
    • 11.1. 内置主题
    • 11.2. 使用既定主题
    • 11.3. sphinx book theme 主题特用指令
    • 11.4. 用户自定义主题
  • 12. Sphinx文档管理与编辑实践
    • 12.1. Sphinx文档项目配置
    • 12.2. Sphinx文档修改要求
    • 12.3. RestructuredText 文档规范
  • 13. 附录
    • 13.1. 术语表
    • 13.2. Sphinx 开发环境配置
    • 13.3. 数学符号
    • 13.4. Web基础知识
    • 13.5. Reference

超链接Hyperlink Targets

目录

  • 3.4.1. 外部链接 External Hyperlink Targets
  • 3.4.2. 锚点链接 Internal Hyperlink Targets
  • 3.4.3. 间接链接 Indirect Hyperlink Targets
  • 3.4.4. Implicit Hyperlink Targets

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`_

上一页

3.3. 列表表示语法

下一页

3.5. Rest文本块

目录
  • 3.4.1. 外部链接 External Hyperlink Targets
  • 3.4.2. 锚点链接 Internal Hyperlink Targets
  • 3.4.3. 间接链接 Indirect Hyperlink Targets
  • 3.4.4. Implicit Hyperlink Targets

作者: BU Kun

© Copyright Since 2023. BU Kun, OSGeo China Chapter.