在協作文檔中指定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中的相對路徑

回答

相關問題