使用 Sphinx 記錄多個 Python 項目

Question

我已經閱讀了一些 Sphinx 教程，但我仍然對如何設置多個項目感到困惑。

我的意思是，安裝 Sphinx 后，本指南說

首先，進入文檔目錄並輸入： $ sphinx-quickstart

假設我有 5 個單獨的 Python 項目，每個項目都在它自己的目錄中（所有單獨的 git 存儲庫等）。

我的問題是， “文檔目錄”究竟是什么（除了顯而易見的）以及在處理多個項目時如何設置 Sphinx？

我是否在某處創建一個“主文檔目錄”，並且在使用 Sphinx 時，是否為每個項目或類似項目創建子目錄？

或者我是否在我的每個項目中創建一個“文檔目錄”並運行$ sphinx-quickstart來為每個單獨的項目設置 Sphinx？

我試圖了解這里的大局，但找不到說明事情這方面的教程。

Answer 1

sphinx-quickstart命令為單個項目生成文檔框架，因此如果您有多個單獨的項目，則必須在每個項目中運行它。 您發布的鏈接使用短語“文檔目錄”，因為項目目錄中的目錄名稱和相對位置由您決定（他們似乎將其放在project_root/doc ），而不是因為應該有一些集中的文檔目錄你所有的項目。