將sphinx文檔與django集成

Question

我已經爲django項目創建了sphinx文檔。它創建了一個build文件夾一個html文件夾和一個index.html文件。我不確定的是如何將index.html文件集成到我的項目中。是否有可能簡單地將其添加到URL配置，如果它將如何格式化？

Answer 1

IMO，做這件事的'最好的'方法就是在HTTP服務器級別，而不是在Django本身（至少我過去是這樣做的）。您不需要或不需要任何Django圖層來提供您的獅身人面像文檔，您只需要一個「vanilla」web服務器設置即可完成此操作。

此外，如果你堅持使用Django，這可能會有所幫助Django urls straight to html template ......但是，我會投票選擇在你的根目錄下設置一個/ docs目錄，並通過基本的Apache/NGINX/etc指向它的sphinx數據配置。

Answer 2

有一些較好的用例斯芬克斯doc的納入的Django：

• 允許文檔內動態內容（即用戶登錄，當前時間等）。
• 將文檔與整體站點地圖相集成。
• 只能創建和維護一組模板/ CSS文件。

如果您有一個或多個需求，我會看看django-sphinxdoc，它可以處理所有基本用例，但可以輕鬆修改。