我正在为我的项目添加一个Read The Docs页面.现在,我想在我的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目录中构建了所有内容,因此期望INSTALL.rst
在docs目录中找到它.
由于Github从root渲染文件,因此它希望INSTALL.rst
在根目录中找到.
我怎样才能使Github和Read The Docs(Sphinx)正确呈现相对链接而不会有重复文件(或者最好是重复文件)?