0

我正在和几个同事一起做一个 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_application_folder\my_application_folder，对于用户 b，它可能是 d:\userb\projects-top\python_application_folder\my_application_folder 我如何在 conf.py 文件中指定适用于所有用户的相对路径，我只是希望它就像查看上一级目录并将代码记录在 ..\my_application_folder

4

2 回答 2

4

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

import os, sys

sys.path.append(os.path.abspath('../my_application_folder'))

这会将绝对路径附加到模块搜索路径my_application_folder列表中。

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

于 2013-07-17T11:33:15.133 回答
2

您可以直接在第一个文档的指令中使用相对路径：

.. literalinclude:: ../my_application_folder/setup.py
    :language: python
于 2013-06-15T09:04:49.153 回答