Sphinx - 包含文件中的相对链接

时间:2016-09-12 14:46:50

标签: python python-sphinx restructuredtext

我正在使用Sphinx来记录C ++项目。我在readme文件夹中有一个src,并且有一个完整的帮助网站,可以发布到使用readthedocs生成的docs文件夹中的sphinx。我想重用readme文件夹中的srcreadme包含src文件夹中的代码(使用literalinclude指令)。

该项目具有以下结构:

project
  src
    algo.cpp
    readme.rst
    CMakeLists.txt
 docs
    source
       index.rst
       conf.py
       code_link.rst
    build
    Makefile

按照question中的建议,我能够将index与我的readme相关联,但readme中代码文件的路径现在相对于docs {1}}。因此,readme不再独立地呈现其自身的重用失败理念。

是否有办法在包含文件中包含相对于包含文件的链接?

0 个答案:

没有答案