首页 > 解决方案 > 文档:使用包含指令(rst,sphinx)时缺少图像

问题描述

我正在使用 rst/sphinx 生成文档,并且在引用文件中的图像存在问题。

include指令可以很好地引入 rst 文件,但我没有从包含的文件中获取本身引用的图像。

我的结构是这样的:

   /documentation
        /master_doc
            /source
                pointer_file.rst  
                    and this file calls file.rst:
                    include:: ../../doc_a/source/file.rst
        /documents
             /doc_a
                  /source
                       /images
                            picture.jpg
                       file.rst
                             includes a figure ref:
                             .. figure:: images/picture.jpg

当我从目录构建时doc_a,我得到文本+图像。都好。但是当我从指令master_doc所在的目录构建时include,我只得到文本并且构建中缺少图像。

我怎样才能解决这个问题?我不想在两个目录中复制我的所有图像,这是目前唯一可行的方法。

***编辑:为上面的项目结构添加了详细信息,因为下面的建议修复尚未起作用。

为了回应第一条评论中的建议,我尝试了以下所有方法,但都没有奏效:

.. figure:: /documentation/documents/doc_a/source/images/picture.jpg

.. figure:: /documents/doc_a/source/images/picture.jpg

.. figure:: /doc_a/source/images/picture.jpg

还有其他想法吗?

标签: imagepython-sphinxrestructuredtext

解决方案


尝试将图像文件路径从相对更改为绝对。

.. figure:: /doc_a/source/images/picture.jpg

来自reStructuredText Primer,图片

在 Sphinx 中使用时,给定的文件名(此处gnu.png)必须是相对于源文件的,或者是绝对的,这意味着它们是相对于顶级源目录的。例如,该文件sketch/spam.rst可以将图像images/spam.png称为../images/spam.png/images/spam.png


推荐阅读