【问题标题】:Sphinx & reStructuredText : how to link an image to a document pageSphinx & reStructuredText:如何将图像链接到文档页面
【发布时间】:2015-11-27 04:32:04
【问题描述】:

在 RST 语法中,您可以指定 :target: 属性来设置链接。我想将图像链接到“materials.rst”文档页面,其主要部分标题为“材料”

但这些都不能作为目标值:

  • :target: `materials`_
  • :target: :doc: materials
  • :target: materials

我怎样才能做到这一点?

【问题讨论】:

  • 我还没有找到办法——我相信这是不可能的。 (同样,我看不到链接到 :ref: 的方法。)
  • :target: materials.html 在您仅构建 html 文档时有效。

标签: image hyperlink python-sphinx restructuredtext


【解决方案1】:

即使在 6 年后也没有修复,尽管 :ref: 现在可以跨文件正常工作。但是,您不能在 image 或 figure 指令中使用 :ref:

试试这个:

:target: materials.html

...希望一切顺利! :target: 角色似乎只接受 HTML 链接。

假设有一个名为 doc.rst 的文件,我想通过另一个文档中的缩略图访问它:

.. _doc:

Some Title
==========

...然后,在另一个文档中,我使用以下解决方案:

.. image:: /media/thumbnail_of_my_doc.jpg
   :ref:`doc` <- doesn't compute
   :target: doc (or doc.rst, or doc_) <- doesn't work either
   :target: doc.html <- works im my case

最后一个选项之所以有效,是因为我假设了要生成的 HTML 的名称。如果我错了怎么办?这是一个纯粹的黑客。 我不敢相信没有人会费心解决这个问题。

我在 Sphinx 4.2.0 上使用 RTD 主题。全部更新到最新版本。

【讨论】:

  • 它的意思是:“不要试图在凌晨 4 点做一个聪明人写答案:)。感谢您的关注,它已修复。
  • 我使用的是 Sphinx 4.4.0,但它似乎仍然只适用于 :target: doc.html - 或者现在还有其他解决方案吗?
最近更新 更多