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

我正在与一些同事一起工作一个python项目，我们有一个中央存储库（Hg），我们可以从中推出和从当地回购站获取大部分开发和文档。 Sphinx非常适合生成文档。结构与此类似在协作文档中指定Sphinx conf.py中的相对路径

projects-top/ 
     +python_application_folder 
      +my_application_folder 
      +docs_folder 
       +docs_build_folder 
       +docs_dist_folder 
        conf.py 
        index.rst

但是目前我们拉和做的工作，以更新我们目前改变conf.py文件说，其中的代码是，obviosuly路径从用户改变用户的文件，在用户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

来源

2013-06-13 user595985

你的结构有点混乱。代码目录究竟在哪里？ – andref

以下内容添加到conf.py：

import os, sys 

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

这将在my_application_folder绝对路径追加到的module search paths列表。

在extensions配置变量的文档中强调absolute paths should be used扩展为sys.path时。我认为主要原因是如果您从configuration directory以外的其他目录运行sphinx-build，相对路径将不起作用。

来源

2013-07-17 11:33:15 mzjn

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

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

来源

2013-06-15 09:04:49 andref

感谢您的回复，现在我应该将其添加到我的index.rst？并删除conf.py文件中的abspath条目？ – user595985

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

回答

相关问题