Python 在Sphinx conf.py中为协作文档指定相对路径

Python 在Sphinx conf.py中为协作文档指定相对路径,python,python-2.7,python-sphinx,Python,Python 2.7,Python Sphinx,我和几位同事正在做一个python项目,我们有一个中央存储库(Hg),我们可以从中推送和提取数据,还有本地回购,我们在那里进行大部分开发和文档编制。Sphinx非常适合生成文档。结构与此类似 projects-top/ +python_application_folder +my_application_folder +docs_folder +docs_build_folder

我和几位同事正在做一个python项目,我们有一个中央存储库(Hg),我们可以从中推送和提取数据,还有本地回购,我们在那里进行大部分开发和文档编制。Sphinx非常适合生成文档。结构与此类似

projects-top/
      +python_application_folder
            +my_application_folder
            +docs_folder
                 +docs_build_folder
                 +docs_dist_folder
                  conf.py
                  index.rst
然而,当前当我们拉入并执行工作时,为了更新文档,我们当前更改conf.py文件以说明代码的位置,很明显,路径在用户之间发生了变化,在用户a上可能是c:\usera\projects top\python\u application\u folder\my\u application\u folder,对于用户b,它可能是d:\userb\projects top\python\u application\u folder\my\u application\u folder
如何在conf.py文件中指定一个适用于所有用户的相对路径,我只希望它像在目录中查找一级并在..\my_application_文件夹中记录代码一样

您可以在rst文档的指令中直接使用相对路径:

.. literalinclude:: ../my_application_folder/setup.py
    :language: python

您可以直接在rst文档中的指令中使用相对路径:

.. literalinclude:: ../my_application_folder/setup.py
    :language: python

将以下内容添加到conf.py:

import os, sys

sys.path.append(os.path.abspath('../my_application_folder'))
这将把
my\u application\u文件夹的绝对路径
附加到列表中


extensions
配置变量的文档中,强调了在扩展
sys.path
时。我认为主要原因是,如果您从非的另一个目录运行,则相对路径将不起作用。

将以下内容添加到conf.py:

import os, sys

sys.path.append(os.path.abspath('../my_application_folder'))
这将把
my\u application\u文件夹的绝对路径
附加到列表中


extensions
配置变量的文档中,强调了在扩展
sys.path
时。我认为主要原因是,如果您从另一个目录运行,而不是从另一个目录运行,则相对路径将不起作用。

您的结构有点混乱。代码目录到底在哪里?您的结构有点混乱。代码目录具体在哪里?感谢您的响应,现在我应该将其添加到index.rst中吗?并删除conf.py文件中的abspath条目?感谢您的响应,现在我应该将其添加到index.rst中吗?并删除conf.py文件中的abspath条目?