I want to include an image in my readme.rst file and whether it displays correctly both in Github and in the documentation generated by Sphinx on ReadTheDocs
The file structure is as follows:
readme.rst
docs/
index.rst
readme.rst
images/
my_image.png
The second readme file contains
.. include:: ../readme.rst
If I specify the path for my_image in the first readme file as
.. image:: images/my_image.png
It displays correctly in the documentation generated by sphinx, both locally and on the ReadTheDocs website. However, it does not appear in the readme section on Github.
For it to appear on Github, I need to change the path to
.. image:: docs/images/my_image.png
but it is no longer displayed in the local sphinx or on the ReadTheDocs website.
, ... - /, , ( ..include Sphinx )?