在sphinx和github中使用相同的README内容 - 相对链接

Question

我为我的项目添加了“阅读文档”页面。现在，我想在我的Read The Docs主页上看到与我的自述文件中相同的内容。我的docs/index.rst文件如下：

.. include:: ../README.rst

.. toctree::
   :maxdepth: 2
   :caption: Contents:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

除相对链接外，这主要有效。例如，我的README包含：

See `INSTALL.rst`_ for advanced and detailed instructions.

由于Sphinx在docs目录中构建了所有内容，因此期望在docs目录中找到INSTALL.rst。

由于Github从root渲染文件，因此它希望在根目录中找到INSTALL.rst。

如何使Github和Read Docs（Sphinx）正确呈现相对链接而不会有重复文件（或者最好是重复文件）？

Answer 1

尝试使用符号链接。

在sphinx目录中：

INSTALL.rst -> ../INSTALL.rst