Сфинкс - ссылка на изображение из разных мест - PullRequest
Новая
       10

Сфинкс - ссылка на изображение из разных мест

0 голосов
/ 02 сентября 2018

Я использую Python Sphinx (через ReadTheDocs ).

У меня есть хранилище, содержащее несколько подмодулей, и я пытаюсь создать единую документацию, но при этом сохраняю ресурсы docs в каждом модуле отдельно.

Моя иерархия папок: 

MyProject
  docs
    index.rst
    module_1_link.rst
      _static
        <more irrelevant assets...>               
  module_1
    docs
      README.rst
      _static
        myimage.png

Файл index.rst выглядит следующим образом: 

.. toctree::
    :caption: Module1
    module_1_link

Файл module_1_link.rst просто содержит ссылку на файл README модуля 1: 

.. include:: ../module1/docs/README.rst

И README.rst модуля 1 ссылается на изображение: 

.. image:: _static/myimage.jpg

Когда я смотрю на файл README модуля 1 (внутри GitHub) - myimage.png отображается отлично.

Но, когда я запускаю документацию через sphinx, я получаю: 

 WARNING: image file not readable: _static/myimage.jpg

Я не могу найти ссылку на одно и то же изображение как из файла README, так и из файла индекса, созданного sphinx, и увидеть его в обоих местах.

1 Ответ

0 голосов
/ 03 сентября 2018

Измените ссылку на изображение в README.rst, чтобы она была относительно корня документации. 

.. image:: /module1/docs/_static/myimage.jpg

См. Также документацию Sphinx о путях к изображениям .

При использовании в Sphinx указанное имя файла (здесь gnu.png) должно быть либо относительно исходного файла, либо абсолютным, что означает, что они относятся к верхнему исходному каталогу. Например, файл sketch/spam.rst может ссылаться на изображение images/spam.png как ../images/spam.png или /images/spam.png.

...