接下来阅读什么¶
所以你已经阅读了所有入门资料,并决定继续使用 Django。这个入门介绍只是触及了皮毛(事实上,如果你读了每一个字,你只读了大约 5% 的全部文档)。
那么接下来是什么呢?
好吧,我们一直以来都非常喜欢在实践中学习。在这一点上,你应该已经了解了足够多的知识来开始你自己的项目并开始尝试了。当你需要学习新的技巧时,可以回到文档中来查找。
我们投入了大量精力,使 Django 的文档尽可能地实用、清晰和完整。本文档的其余部分将更详细地解释文档的工作方式,以便你能够充分利用它。
(是的,这是关于文档的文档。请放心,我们不打算编写关于如何阅读关于文档的文档的文档。)
查找文档¶
Django 有 *大量* 的文档——将近 45 万字,而且还在不断增加——因此查找所需内容有时可能很棘手。索引 是一个不错的起点。我们还建议使用内置的搜索功能。
或者你也可以随意浏览!
文档的组织方式¶
Django 的主要文档被分解成“块”,旨在满足不同的需求。
入门资料 是为 Django 新手——或 Web 开发新手设计的。它不会深入探讨任何内容,而是对 Django 开发的“感觉”进行高级概述。
另一方面,主题指南 深入探讨了 Django 的各个部分。这里有关于 Django 的模型系统、模板引擎、表单框架等等的完整指南。
这可能是你想要花费大部分时间的地方;如果你学习了这些指南,你应该就能了解 Django 的几乎所有知识。
Web 开发通常是广度大于深度——问题涵盖许多领域。我们编写了一套操作指南,回答常见的“我该如何……?”问题。在这里,你将找到有关使用 Django 生成 PDF、编写自定义模板标签等等的信息。
常见问题的答案也可以在常见问题解答中找到。
指南和操作指南并没有涵盖 Django 中可用的每个类、函数和方法——当你试图学习时,这将是压倒性的。相反,关于各个类、函数、方法和模块的详细信息保存在参考中。你将在这里找到特定函数或任何你需要的信息的详细信息。
最后,还有一些“专业”文档,通常与大多数开发者无关。这包括发行说明和内部文档(供希望向 Django 本身添加代码的人员使用),以及其他一些不适合其他地方的内容。
文档更新方式¶
就像 Django 代码库每天都在开发和改进一样,我们的文档也在不断改进。我们出于几个原因改进文档
进行内容修正,例如语法/错别字更正。
向需要扩展的现有部分添加信息和/或示例。
记录尚未记录的 Django 功能。(此类功能列表正在减少,但仍然存在。)
随着新功能的添加,或 Django API 或行为的变化,为新功能添加文档。
Django 的文档与它的代码保存在相同的源代码控制系统中。它位于我们 Git 存储库的docs目录中。在线的每个文档都是存储库中的一个单独文本文件。
获取文档的方法¶
你可以通过几种方式阅读 Django 文档。按优先级顺序排列:
在网上¶
最新版本的 Django 文档位于https://docs.djangopy.cn/en/dev/。这些 HTML 页面是从源代码控制中的文本文件自动生成的。这意味着它们反映了 Django 的“最新和最伟大的”——它们包含最新的更正和新增内容,并且讨论了最新的 Django 功能,这些功能可能仅适用于 Django 开发版本的使用者。(参见下面的不同版本之间的差异。)
我们鼓励你通过在工单系统中提交更改、更正和建议来帮助改进文档。Django 开发人员积极监控工单系统,并使用你的反馈来改进每个人的文档。
但是,请注意,工单应明确地与文档相关,而不是提出广泛的技术支持问题。如果你需要帮助来设置你的 Django,请尝试使用django-users邮件列表或#django IRC 频道。
纯文本¶
为了离线阅读,或者仅仅为了方便起见,你可以阅读 Django 的纯文本文档。
如果你使用的是 Django 的正式版本,则代码的压缩包(tarball)包含一个docs/
目录,其中包含该版本的所有文档。
如果你使用的是 Django 的开发版本(也就是主分支),则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,方法是从 Sphinx 网站下载并安装软件包,或者使用
pip
$ 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 存储库主分支中的文本文档包含“最新和最棒的”更改和新增内容。这些更改包括针对 Django 的下一个功能版本 的新功能文档。因此,值得指出我们突出显示 Django 最新更改和新增内容的策略。
我们遵循以下策略:
https://docs.djangopy.cn/en/dev/ 上的开发文档来自主分支。这些文档对应于最新的功能版本,以及自那时以来在框架中添加/更改的任何功能。
当我们向 Django 的开发版本添加功能时,我们在相同的 Git 提交事务中更新文档。
为了区分文档中的功能更改/添加,我们使用短语:“Django 开发版本的新增功能”表示尚未发布的 Django 版本,或“X.Y 版本的新增功能”表示已发布的版本。
文档修复和改进可能会根据合并者的判断回传到最后一个发行分支,但是,一旦 Django 的某个版本不再受支持,该版本的文档将不会再获得任何进一步的更新。
主要文档网页包含指向以前版本文档的链接。请确保你使用的是与你使用的 Django 版本相对应的文档版本!