接下来阅读¶
所以你已经阅读了所有的 介绍材料,并决定你想继续使用Django。我们只是用这个介绍(实际上,如果你读了每一个单词,你已经阅读了大约5%的文档)。
那么接下来是什么呢?
那么,我们一直是学习的大粉丝。在这一点上,你应该知道足够开始一个自己的项目,开始愚弄。当你需要学习新的技巧,回到文档。
我们已经投入了大量精力使Django的文档变得有用,易于阅读和尽可能完整。本文档的其余部分解释了文档如何工作,以便您可以充分利用它。
(是的,这是关于文档的文档。请放心,我们没有打算写一篇关于如何阅读文档的文档的计划。)
如何组织文档¶
Django的主要文档被分解为“chunks”,旨在满足不同的需求:
介绍材料 是专为新的Django或一般的Web开发人员。它不深入地覆盖任何东西,而是给出了如何在Django中开发的高级概述“感觉”。
另一方面,主题指南 深入到Django的各个部分。有完整的指南,Django的 模型系统,模板引擎,形式框架,等等。
这可能是你想花大部分时间;如果你的工作方式通过这些指南,你应该出来知道几乎一切都知道关于Django。
Web开发通常是广泛的,不深入 - 问题跨越许多领域。我们写了一套 如何指导 来回答常见的“我怎么...?问题。在这里,您可以找到有关 使用Django生成PDF,编写自定义模板标记 等的信息。
对真正常见问题的答案也可以在 常问问题 中找到。
指南和操作方法不包括Django中提供的每一个类,函数和方法 - 当你试图学习时,这将是压倒性的。相反,有关各个类,函数,方法和模块的详细信息保存在 参考 中。这是你将在哪里找到一个特定的功能或任何你需要的细节。
如果你有兴趣部署一个项目为公众使用,我们的文档有 several guides 的各种部署设置,以及一些你需要考虑的事情的 deployment checklist。
最后,有一些“专门的”文档通常不与大多数开发人员相关。这包括 发行说明 和 内部文档 为那些谁想要添加代码到Django本身和一个 几乎没有其他东西,只是不适合其他地方。
如何更新文档¶
正如Django代码库是每天开发和改进一样,我们的文档不断改进。我们改进文档有几个原因:
修改内容,例如语法/拼写更正。
向需要扩展的现有节添加信息和/或示例。
记录尚未记录的Django功能。 (这些功能的列表正在缩小,但仍然存在。)
在添加新功能或添加Django API或行为更改时添加新功能的文档。
Django的文档保存在与其代码相同的源代码管理系统中。它存在于我们的Git仓库的 docs 目录中。在线的每个文档都是存储库中的一个单独的文本文件。
在哪里得到它¶
你可以通过几种方式阅读Django文档。它们按照优选顺序:
在网上¶
Django文档的最新版本存在于 https://docs.djangoproject.com/en/dev/。这些HTML页面是从源代码控制中的文本文件自动生成的。这意味着它们反映了Django中的“最新和最好的” - 它们包括最新的更正和添加,并讨论了最新的Django功能,这些功能只能供Django开发版本的用户使用。 (请参阅下面的“版本之间的差异”。)
我们鼓励您通过在 ticket system 中提交更改,更正和建议来帮助改进文档。 Django开发人员主动监视票证系统,并使用您的反馈来改进每个人的文档。
然而,请注意,机票应明确与文档相关,而不是要求广泛的技术支持问题。如果您需要帮助您的特定Django设置,请尝试 django-users 邮寄名单或 #django IRC channel。
纯文本¶
对于离线阅读,或为了方便起见,您可以以纯文本阅读Django文档。
如果您使用的是Django的官方版本,请注意代码的压缩包(tarball)包含一个 docs/
目录,其中包含该版本的所有文档。
如果您使用的是Django(也称为“trunk”)的开发版本,请注意,docs/
目录包含所有文档。您可以更新您的Git checkout以获取最新更改。
利用文本文档的一种低技术方法是使用Unix grep
实用程序在所有文档中搜索短语。例如,这将向您显示在任何Django文档中每次提及短语“max_length”:
$ grep -r max_length /path/to/django/docs/
作为HTML,本地¶
您可以通过以下几个简单的步骤获取HTML文档的本地副本:
版本之间的差异¶
如前所述,Git存储库中的文本文档包含“最新和最大”的更改和添加。这些更改通常包括在Django开发版本中添加的新功能的文档 - Django的Git(“trunk”)版本。因此,值得指出的是我们关于保持框架各种版本的文档的政策。
我们遵循此政策:
djangoproject.com的主要文档是Git中最新文档的HTML版本。这些文档始终对应于最新的官方Django版本,以及我们在 since 最新版本中添加/更改的功能。
当我们为Django的开发版本添加特性时,我们尝试在同一Git提交事务中更新文档。
要区分文档中的要素更改/添加,我们使用短语“新版本X.Y”,在下一个发行版本(因此,正在开发)中为X.Y。
文档修复和改进可以由提交者自行决定,返回到最后一个发布分支,但是,一旦Django的版本是 no longer supported,该版本的文档将不会得到任何进一步的更新。
main documentation Web page 包括所有先前版本的文档的链接。确保您使用的是与您使用的Django版本相对应的文档版本!