使用Sphinx來記錄多個Python目標

我開始使用Sphinx。我已經閱讀了一些教程，但是我仍然對如何設置多個項目有些掛念。使用Sphinx來記錄多個Python目標

我的意思是，在安裝獅身人面像後，this guide說

要開始時，cd到文檔目錄和類型：$ sphinx-quickstart

比方說，我有5個單獨的Python每個項目它是自己的目錄（所有個人git回購等）。

我的問題是，究竟是什麼「文檔目錄」（除了顯而易見的），我如何與多個項目時設立獅身人面像？

我在一個地方製作一個「主文檔目錄」，當我使用Sphinx時，是否爲每個項目或類似的目錄創建子目錄？

或者我可以在每個項目中創建一個「文檔目錄」並運行$ sphinx-quickstart來爲每個單獨的項目設置Sphinx？

我想了解這裏的大圖，但無法找到一個教程，闡明瞭這方面的事情。

來源

2016-09-25 DelightedD0D

你是什麼意思*「設置多個項目」*。如果他們是分開的，在單獨的目錄中，那麼當然你必須每次都「快速啓動」。或者你想以某種方式將它們結合起來？ – jonrsharpe

@jonrsharpe這是我的想法，但我只是無法確定。對我來說，教程不會明確*文檔目錄*應該在哪裏。我不確定Sphinx是否希望這個文件夾能夠像我所有文檔的中央庫，或者'sphinx-quickstart'是爲每個項目運行，比如'git init'等。似乎你的答案是每個項目的後續版本建立。建議在我的Python項目中還是在其外部創建文檔目錄？ – DelightedD0D

它讀取*「文檔目錄」*，因爲項目目錄中的目錄名稱和相對位置取決於您。我通常通過http://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/將它放在'project_root/docs'中。看看你發佈的鏈接，他們似乎使用'doc'代替。 – jonrsharpe

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

來源

2016-09-25 10:00:01 jonrsharpe

使用Sphinx來記錄多個Python目標

回答

相關問題