下一步阅读什么 — Django 文档
下一步看什么
所以你已经阅读了所有的 介绍材料 并决定你想继续使用 Django。 我们只是从介绍中触及了皮毛(事实上,如果您阅读了每个单词,那么您已经阅读了整个文档的大约 5% of)。
下一个是什么?
嗯,我们一直是边做边学的忠实粉丝。 在这一点上,您应该足够了解开始自己的项目并开始闲逛。 当您需要学习新技巧时,请返回文档。
我们付出了很多努力使 Django 的文档变得有用、易于阅读和尽可能完整。 本文档的其余部分详细介绍了文档的工作原理,以便您可以充分利用它。
(是的,这是关于文档的文档。 请放心,我们没有计划编写有关如何阅读有关文档的文档的文档。)
文档的组织方式
Django 的主要文档被分解成旨在满足不同需求的“块”:
介绍材料 是为刚接触 Django 或一般 Web 开发的人设计的。 它没有深入介绍任何内容,而是对在 Django 中开发的“感觉”进行了高层次的概述。
另一方面, 主题指南 深入探讨了 Django 的各个部分。 有关于 Django 的 模型系统 、 模板引擎 、 表单框架 等的完整指南。
这可能是您想花费大部分时间的地方; 如果您通过这些指南工作,您应该几乎了解有关 Django 的所有知识。
Web 开发通常是广泛的,而不是深入的——问题跨越许多领域。 我们已经编写了一套 操作指南 来回答常见的“我如何......?” 问题。 在这里,您将找到有关 使用 Django 生成 PDF、 编写自定义模板标签 等的信息。
在 FAQ 中也可以找到真正常见问题的答案。
指南和操作方法并未涵盖 Django 中可用的每一个类、函数和方法——当您尝试学习时,这会让人不知所措。 相反,有关单个类、函数、方法和模块的详细信息保存在 参考文献 中。 您可以在此处找到特定功能的详细信息或您需要的任何内容。
如果您有兴趣部署一个项目供公众使用,我们的文档有 多个指南 用于各种部署设置,以及 部署清单 用于您需要考虑的一些事情。
最后,还有一些“专门的”文档,通常与大多数开发人员无关。 这包括 发行说明 和 内部文档 ,适用于那些想要向 Django 本身添加代码的人,以及 一些其他地方根本不适合的东西 。
这个文档是如何更新的
正如 Django 代码库每天都在开发和改进一样,我们的文档也在不断改进。 我们出于以下几个原因改进文档:
- 更正内容,如更正语法/拼写错误。
- 向已有的需要被扩展的某个章节添加介绍信息或例子。
- 记录尚未记录的 Django 功能。 (此类功能的列表正在缩小,但仍然存在。)
- 在新特性被添加时,或 Django 的 API 或行为有变化时,会添加新文档。
Django 的文档与其代码保存在同一源代码控制系统中。 它位于我们 Git 存储库的 :source:`docs` 目录中。 每个在线文档都是存储库中的一个单独的文本文件。
从哪里获取这个
您可以通过多种方式阅读 Django 文档。 它们是,按优先顺序:
在网络上
Django 文档的最新版本位于 https://docs.djangoproject.com/en/dev/。 这些 HTML 页面是从源代码管理中的文本文件自动生成的。 这意味着它们反映了 Django 中“最新最好的”——它们包括最新的更正和补充,并且它们讨论了最新的 Django 功能,这些功能可能只对 Django 开发版本的用户可用。 (请参阅下面的 版本之间的差异 。)
我们鼓励您通过在 票务系统 中提交更改、更正和建议来帮助改进文档。 Django 开发人员积极监控票务系统,并使用您的反馈为每个人改进文档。
但是请注意,票证应明确与文档相关,而不是询问广泛的技术支持问题。 如果您需要有关特定 Django 设置的帮助,请尝试 django-users 邮件列表或 #django IRC 频道 。
纯文本形式
离线阅读,或仅仅是为了方便,你可以阅读 Djano 文档的纯文本形式。
如果您使用的是 Django 的官方发行版,则代码的压缩包(tarball)包含一个 docs/
目录,其中包含该发行版的所有文档。
如果您使用的是 Django 的开发版本(又名 master 分支),则 docs/
目录包含所有文档。 您可以更新您的 Git 结帐以获取最新更改。
利用文本文档的一种低技术方法是使用 Unix grep
实用程序在所有文档中搜索短语。 例如,这将显示在任何 Django 文档中每次提及短语“max_length”:
以本地网页形式阅读
经过几步操作,你可以获得一份网页文档的副本:
Django 的文档使用一个名为 Sphinx 的系统将纯文本转换为 HTML。 您需要通过从 Sphinx 网站下载并安装软件包或使用
pip
来安装 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 存储库 master 分支中的文本文档包含“最新和最伟大”的更改和添加。 这些更改包括针对 Django 下一个 功能版本 的新功能的文档。 出于这个原因,值得指出我们的政策,以突出 Django 的最近更改和添加。
我们遵循以下原则:
- https://docs.djangoproject.com/en/dev/ 上的开发文档来自 master 分支。 这些文档对应于最新的功能版本,以及从那时起在框架中添加/更改的任何功能。
- 当我们向 Django 的开发版本添加功能时,我们会在同一个 Git 提交事务中更新文档。
- 为了区分文档中的功能更改/添加,我们使用短语:“Django 开发版本中的新功能”表示尚未发布的 Django 版本,或“XY 版本中的新功能”表示发布版本。
- 文档修复和改进可能会向后移植到最后一个发布分支,由提交者自行决定,但是,一旦 Django 版本 不再受支持 ,该版本的文档将不会得到任何进一步的更新.
- 主文档网页 包含指向先前版本文档的链接。 确保您使用的文档版本与您正在使用的 Django 版本相对应!