接下來閱讀什麼¶
您已經讀完了所有的入門資料,並決定要繼續使用 Django。這個入門只是淺嚐即止 (事實上,如果您讀完了每一個字,您只讀了整體文件的 5%)。
那麼接下來呢?
嗯,我們一直以來都非常支持從實作中學習。此時您應該已經了解足夠的知識來開始自己的專案並開始嘗試。當您需要學習新技巧時,請回到文件。
我們投入了很多努力讓 Django 的文件變得實用、清晰且盡可能完整。本文的其餘部分將更詳細地說明文件的工作原理,以便您可以充分利用它。
(是的,這是關於文件的文件。請放心,我們沒有計劃撰寫關於如何閱讀關於文件的文件的文件。)
尋找文件¶
Django 有很多文件 – 將近 450,000 字且持續增加中 – 因此找到您需要的內容有時可能很棘手。一個好的開始地點是索引。我們也建議使用內建的搜尋功能。
或者您可以四處瀏覽!
文件如何組織¶
Django 的主要文件分為旨在滿足不同需求的「區塊」
入門資料是為 Django 新手或整體網頁開發新手設計的。它不深入探討任何內容,而是對 Django 開發的「感覺」進行高層次的概述。
另一方面,主題指南深入探討 Django 的各個部分。這裡有關於 Django 的模型系統、模板引擎、表單框架等等的完整指南。
這可能是您會花費大部分時間的地方;如果您仔細閱讀這些指南,您應該會了解幾乎所有關於 Django 的知識。
網頁開發通常範圍廣泛,但不深入 – 問題跨越多個領域。我們編寫了一組操作指南,回答常見的「我該如何……?」問題。在這裡,您將找到關於使用 Django 產生 PDF、編寫自訂範本標籤等等的資訊。
常見問題的答案也可以在常見問題中找到。
指南和操作指南並未涵蓋 Django 中提供的每個類別、函數和方法 – 這在您嘗試學習時會讓人不知所措。相反,關於個別類別、函數、方法和模組的詳細資訊會保留在參考資料中。您可以在這裡找到特定函數或您需要的任何詳細資訊。
最後,還有一些「專業」文件,通常與大多數開發人員無關。這包括版本說明和為那些想要向 Django 本身添加程式碼的人提供的內部文件,以及其他一些不適合放在其他地方的內容。
文件如何更新¶
就像 Django 程式碼庫每天都在開發和改進一樣,我們的文件也在不斷改進。我們改進文件的原因有幾個
進行內容修復,例如文法/拼寫錯誤更正。
在需要擴充的現有章節中新增資訊和/或範例。
記錄尚未記錄的 Django 功能。(此類功能的列表正在縮小,但仍然存在。)
隨著新功能的加入,或隨著 Django API 或行為的變更,為新功能添加文件。
Django 的文件與其程式碼保留在相同的原始碼控制系統中。它位於我們 Git 儲存庫的docs目錄中。線上的每個文件都是儲存庫中的一個獨立文字檔案。
從哪裡取得¶
您可以透過幾種方式閱讀 Django 文件。它們的偏好順序如下
在網路上¶
最新版本的 Django 文件位於https://django-docs.dev.org.tw/en/dev/。這些 HTML 頁面是從原始碼控制中的文字檔案自動產生的。這意味著它們反映了 Django 的「最新和最棒」– 它們包含最新的更正和新增內容,並且它們討論了最新的 Django 功能,這些功能可能僅適用於 Django 開發版本的用戶。(請參閱下方的版本之間的差異。)
我們鼓勵您透過在票證系統中提交變更、更正和建議來協助改進文件。Django 開發人員會積極監控票證系統,並使用您的回饋來改善所有人的文件。
但是請注意,票證應明確與文件相關,而不是詢問廣泛的技術支援問題。如果您需要有關特定 Django 設定的協助,請嘗試使用django-users郵件列表或#django IRC 頻道。
以純文字格式¶
為了方便離線閱讀,或者只是為了方便起見,您可以閱讀純文字格式的 Django 文件。
如果您使用的是 Django 的官方發行版本,則程式碼的壓縮套件 (tarball) 包含一個docs/
目錄,其中包含該發行版本的所有文件。
如果您使用的是 Django 的開發版本 (又稱 main 分支),則docs/
目錄包含所有文件。您可以更新您的 Git 結帳以取得最新的變更。
利用文字文件的一種低技術方法是使用 Unix grep
工具在所有文件中搜尋詞組。例如,這會在任何 Django 文件中顯示每次提及「max_length」詞組的情況
$ grep -r max_length /path/to/django/docs/
...\> grep -r max_length \path\to\django\docs\
在本地以 HTML 格式呈現¶
您可以按照幾個步驟取得 HTML 文件的本機副本
Django 的文件使用一個稱為Sphinx的系統將純文字轉換為 HTML。您需要從 Sphinx 網站下載並安裝套件,或使用
pip
安裝 Sphinx$ python -m pip install Sphinx
...\> py -m pip install Sphinx
然後,使用內含的
Makefile
將文件轉換為 HTML$ cd path/to/django/docs $ make html
您需要安裝GNU Make才能執行此操作。
如果您使用的是 Windows,您也可以使用內含的批次檔
cd path\to\django\docs make.bat html
HTML 文件將放置在
docs/_build/html
中。
版本之間的差異¶
Git 儲存庫 main 分支中的文字文件包含「最新和最棒」的變更和新增內容。這些變更包括針對 Django 的下一個功能版本的新功能的記錄。因此,值得指出我們強調 Django 近期變更和新增內容的原則。
我們遵循以下原則
https://django-docs.dev.org.tw/en/dev/上的開發文件來自 main 分支。這些文件對應於最新的功能版本,以及自那時起在框架中新增/變更的任何功能。
當我們將功能新增至 Django 的開發版本時,我們會以相同的 Git 提交交易更新文件。
為了區分文件中功能變更/新增,我們對尚未發佈的 Django 版本使用短語:「Django 開發版本的新功能」,或者對已發佈的版本使用「X.Y 版的新功能」。
文件修復和改進可能會回溯到最後一個發行分支,由合併者酌情決定,但是一旦 Django 的版本不再支援,該版本的文件將不會再收到任何更新。
此主要文件網頁包含先前版本的文件連結。請務必使用與您使用的 Django 版本相對應的文件版本!