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

2024-04-07

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

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


最好的选择是使用代换 https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions, rst_epilog https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_epilog, and raw-html如本文所述回答 mailto 链接 https://stackoverflow.com/a/44593780/2214933.

In your conf.py:

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

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

In your *.rst:

Please |download| my file.

The extlink扩大 http://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html很接近,但假设您希望使用 URL 作为该站点其他链接的基础。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

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

  • 通过序言格式化 csv 表?

    尽我所能 我无法弄清楚如何更改 sphinx 的 pdf 输出中的默认表格格式 我可以编辑 tex 文件或 writer py 源代码 但这两个似乎都是不好的选择 有什么东西可以通过序言来实现这一点吗 取决于您试图通过更改表格格式来完成的任
  • 为具有特定标题的通用狮身人面像警告定义标记

    我正在使用 Sphinx 为 Python 程序生成 HTML 文档 我想使用generic admonition http docutils sourceforge net docs ref rst directives html gen
  • 将可点击的 SVG 图像插入 Sphinx 文档

    我有 SVG 图像文件 其中有多个节点 每个节点都与 URL 关联 如果我直接在浏览器中打开此文件 我可以单击每个节点 它将打开不同的 URL 但是 当我在 Sphinx 文档中使用这张图片时 它不起作用 图片作为一个整体呈现 所以我需要通
  • Python-Sphinx:从超类“继承”方法文档

    Edit 截至目前 Sphinx 1 4 9 似乎没有办法告诉 Sphinx 做我想做的事情 参见issue https github com sphinx doc sphinx issues 3140在 GitHub 上 这接受的答案 h
  • Sphinx 文档中使用全局变量标准化链接

    我正在使用 Sphinx 来记录工作项目 我想在整个文档的多个页面上使用指向下载的相同链接 例如 home rst Hi I want you to download my project download blah com downloa
  • 我可以在 reStructuredText 中使用内联原始 LaTeX

    我正在尝试将 LaTeX 变量嵌入到一些 reStructuredText 中 我知道 raw 指令 但我希望将其嵌入到文本段落中 具体来说 我希望从模板考试文档中复制 numquestions 和 numpoints 变量 我尝试过使用
  • 通过 :ref:? 从 ReST 文档中提取文本块

    我有一些 reStructuredText 文档 我想在在线帮助中使用其中的片段 似乎一种方法是通过引用 剪掉 标记片段 例如 my boring section Introductory prose blah blah blah my i
  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som
  • 用于将一个文档包含到另一个文档中的 sphinx 指令是什么?

    在我的文档中我有一个examples我可以说的目录 literalinclude examples 1 basic usage py language python linenos 效果很好 因为它们是代码 并且它们的格式正确为代码 但是
  • 如何收集 Sphinx 中的所有外部链接?

    我必须在手册中放入一些外部链接 并且希望在 部分甚至整本书的末尾 不重要 列出所有链接 而无需手动重复它们 我怎样才能做到这一点 这是带有参考书目的文档的摘录 呈现的版本是here http packages python org pyte
  • 使用 Sphinx 时,如何记录没有文档字符串的成员?

    我正在为我发布的包编写文档 我发现您的文档越全面 人们就越容易找到您的包来使用 废话 实际上 我在充满爱心地编写代码的所有功能和细节方面获得了很多乐趣 然而 我对如何为类级变量编写与 Sphinx 兼容的文档感到完全困惑 特别是 我有一些e
  • 在 Sphinx 文档中*仅*显示文档字符串?

    Sphinx有一个功能叫做automethod从方法的文档字符串中提取文档并将其嵌入到文档中 但它不仅嵌入了文档字符串 还嵌入了方法签名 名称 参数 我如何嵌入only文档字符串 不包括方法签名 ref http www sphinx do
  • reStructuredText 页面中的非 TOC 标题

    我正在使用 Sphinx 编写一些文档 有没有一种方法可以格式化页面中不成为目录一部分的标题 理想情况下 有一些反映在格式中的层次结构吗 例如 我想要做 My page TOC heading Subheading not in TOC a
  • Mathworks 生成 Matlab HTML 文档的方法是什么?

    我正在开发共享的 Matlab 代码 我们希望在本地网络中将生成的文档作为可搜索的 HTML 文档共享 我知道以下生成文档的方法 编写一个类似于 C 文件的转换器 这是在中完成的将 Doxygen 与 Matlab 结合使用 http ww
  • 如何在代码块中包含内部引用?

    在我的 Sphinx rst 文档中 我有一个代码块 其中包含使用 UNIX 的产品结构的树视图tree命令 parent child grandchild 它位于代码块中 以便 Sphinx 保留空格 我希望读者能够单击每个节点来关注内部
  • Sphinx 文档包中 LaTeX 输出的自定义颜色

    我试图在使用 Sphinx 文档包和 html 输出时自定义 LaTeX 内联公式的颜色 细节 我有一个名为func rst 其中包括以下行 Let math x 1 be a binary variable 在我用 Sphinx 创建的文
  • 在 Sphinx 中,有没有办法在声明参数的同时记录参数?

    我更喜欢在声明参数的同一行记录每个参数 根据需要 以便应用D R Y http en wikipedia org wiki Don t repeat yourself 如果我有这样的代码 def foo flab nickers a ser
  • 从文档字符串生成 sphinx 文档不起作用

    我有一个具有以下结构的项目 我想保留 my project build here is where sphinx should dump into requirements txt make bat Makefile more config
  • Python 将 sphinx RST 转换为 HTML

    我试过这段代码 from docutils core import publish string text publish string open file path r read writer name html 但它说 p Unknow
  • 如何从命令行设置Sphinx的`exclude_patterns`?

    我在 Windows 上使用 Sphinx 我的大部分文档都是针对普通用户的 但也有一些子页面的内容仅供管理员使用 因此 我想构建文档的两个版本 一个完整 版本 以及排除 管理 页面的第二个版本 我用的是exclude patterns在构

随机推荐

  • 仅当 Perl 脚本未使用 require 加载时,如何才能运行它?

    我有一个 Perl 脚本 如果直接从命令行调用它 我想运行sub main 如果使用 require 调用它 我不想执行任何操作并等待调用者脚本调用sub job闲暇时 对于需要从脚本和 Perl 模块运行的代码 有一个推荐的 Perl 解
  • 为具有 # 次浏览次数的单页网站启用 Google 分析

    我读过类似的问题 但我的问题略有不同 我正在使用 Kendo UI 为网站实现单页注册处理页面 该网站有 4 个页面 当用户单击菜单选项卡时动态生成 例如 当用户单击菜单上的 tab1 时 则tab 1将被注入app container容器
  • 包含原始数据的头文件的用途是什么?

    决定检查一些除了我自己的代码之外的代码 Quake I https github com id Software Quake就是选择 我点击的第一个文件只包含原始数据 唯一的注释是 GP L 我猜它是一个包含法向量的数组 不管它的目的是什么
  • java jaxb简单解析需要@XmlAccessorType(XmlAccessType.FIELD)注释

    我正在尝试将 xml 解析为 java 对象 我已阅读并实现了以下教程 http www vogella com articles JAXB article html http www vogella com articles JAXB a
  • PHP/MySQL:从数据库中选择靠近给定位置的位置

    在 PHP 中 我有以下代码用于计算两个位置之间的距离
  • 如何在 Firefox WebExtensions 附加组件中使用 chrome.storage 和 runtime.connect

    我正在尝试创建一个 Firefox 插件来执行以下操作 单击页面主体时向后台脚本发送消息 发送的消息由后台脚本存储 后台脚本检索存储的消息 单击加载项浏览器按钮时 存储的消息将从后台脚本发送到内容脚本 内容脚本显示收到的消息 我正在使用适用
  • 使用 xml2js 在 Angular 6 中未定义 parseString

    到目前为止 我无法使用 Angular 6 让 xml2js 代码正常工作 我有一个 service ts 返回 xml 但是当调用 xml2js parseString 转换为 json 时 我始终收到未定义的错误 core js 167
  • 这个排序算法的名称是什么?

    for int i 0 i
  • 如何阅读linkedin收件箱消息[关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我对 linkedin api 进行了大量研究 以了解如何通过Api https developer linkedin com res
  • RecyclerView 正在切断最后一项

    我有一个带有工具栏和里面有 recyclerView 的片段 我正在用虚拟数据填充 recyclerView 然后尝试显示它们 由于某种原因 recyclerView 的最后一个元素被截断 这是该片段的 XML
  • Python 中的鲍勃计数器

    使用 Python 2 7 我试图计算短语 bobbbobobboobobookobobbobbboj 中 bob 出现的次数 为此 我编写了以下代码 b 0 string bobbbobobboobobookobobbobbboj str
  • 解构对象作为函数参数

    不太明白这个参数const Posts以下 我对 Node React 还很陌生 它是解构的参数对象吗 或者它只是作为参数传递的对象 getPosts 和 post 显示为未定义 但我不明白参数对象是从哪里传递到函数中的 完整代码在这里 h
  • Visual Studio 2010:向 2008 生成的 wsdl 添加服务引用

    不生成 app config 在我的团队中有一个人拥有 Visual Studio 2008 他创建了一个 Web 服务 然后我将这个 Web 服务添加到控制台项目中 添加服务引用没有问题 但不会生成有效的 app config 只不过是空
  • 在 R 中对非常小的值使用舍入函数返回零

    有时我必须处理非常低的 p 值并以表格格式呈现它们 R 返回的值可以具有很长的有效数字 即小数点后的数字 现在 由于 p 值无论如何都很低 我倾向于在将它们写入 xls 或 tsv 文件之前缩短它们 只是为了使表格看起来漂亮 我在用R ve
  • docker python 自定义模块未找到

    我是 docker 新手 正在尝试将一个简单的应用程序移至 docker 我可以使用 pip install 导入Python标准模块 但是 我有一些想要使用的自定义 python 实用程序文件 这些文件位于单独的包 utils 中 在我的
  • 无限循环使 TimeManager 失效

    我在 WPF 应用程序中遇到了一个非常棘手的缺陷 需要追踪 错误信息是 无限循环似乎是由重复导致的 在布局 渲染过程中使 TimeManager 无效 堆栈跟踪 就其价值而言 是 在 System Windows Media MediaCo
  • TortoiseSVN无法验证

    在我之前的问题之后 TortoiseSVN无法连接 https stackoverflow com questions 11820835 tortoisesvn cant connect解决了 我又遇到了新的问题 在托管我的 svn 存储库
  • 当我尝试在 Windows PC 上安装 PySide2 时,为什么总是出现错误?

    我一直在尝试安装PySide2在我的电脑上 Windows 10 64bits with Python 3 8已安装 但每次都出现错误 我使用了命令pip install PySide2 它对我不起作用 任何帮助将不胜感激 Error ER
  • Linux 如何知道何时为调用堆栈分配更多页面?

    鉴于以下程序 segfault 顾名思义 将通过访问堆栈下方的 256k 来使程序出现段错误 nofault 然而 逐渐将堆栈推到下方 1m 但永远不会出现段错误 此外 运行segfault after nofault 也不会导致错误 如果
  • Sphinx 文档中使用全局变量标准化链接

    我正在使用 Sphinx 来记录工作项目 我想在整个文档的多个页面上使用指向下载的相同链接 例如 home rst Hi I want you to download my project download blah com downloa