所以你已经读过所有的 introductory material 并决定继续使用Django。这篇介绍我们只是触及了表面(事实上,如果您读了每一个单词,那么您就阅读了整个文档的大约5%)。
那么接下来是什么?
嗯,我们一直是边做边学的忠实粉丝。此时,您应该有足够的了解来开始自己的项目并开始闲逛。当您需要学习新技巧时,请返回文档。
我们付出了很多努力,让Django的文档尽可能有用、清晰且完整。本文档的其余部分详细解释了该文档的工作原理,以便您可以充分利用它。
(Yes,这是关于文档的文档。请放心,我们没有计划编写有关如何阅读有关文档的文档。)
姜戈有一个 lot 文档数量--近450,000字,而且还在增加--因此找到您需要的内容有时可能很棘手。一个好的起点是 索引 .我们还建议使用内置搜索功能。
或者您可以随便浏览一下!
Django的主要文档被分解为旨在满足不同需求的“块”:
这个 introductory material 是为Django--或一般的Web开发新手--设计的。它没有深入介绍任何内容,而是提供了在Django中进行开发的“感觉”的高级概述。
这个 topic guides 另一方面,深入了解姜戈的各个部分。有完整的姜戈指南 model system , template engine , forms framework ,以及更多。
这可能是您想花大部分时间的地方;如果您仔细阅读这些指南,您应该了解有关Django的所有信息。
Web开发通常是广泛的,而不是深入的--问题跨越许多领域。我们写了一套 how-to guides 回答常见的“我该怎么.?”“问题。在这里您会找到有关 generating PDFs with Django , writing custom template tags ,以及更多。
真正常见问题的答案也可以在 FAQ 。
指南和操作方法并没有涵盖Django中可用的每一个类、功能和方法--当您试图学习时,这将是压倒性的。相反,有关各个类、函数、方法和模块的详细信息保存在 reference .您可以在这里查找特定功能或任何您需要的细节。
如果您有兴趣部署项目供公众使用,我们的文档有 several guides 用于各种部署设置以及 deployment checklist 有些事情你需要考虑。
最后,还有一些通常与大多数开发人员无关的“专门”文档。这包括 release notes 和 internals documentation 对于那些想要向Django本身添加代码的人来说,还有一个 few other things that don't fit elsewhere 。
正如Django代码库每天都在开发和改进一样,我们的文档也在不断改进。我们改进文档有几个原因:
进行内容修复,例如语法/拼写错误更正。
向需要扩展的现有部分添加信息和/或示例。
记录尚未记录的Django功能。(The此类功能的列表正在减少,但仍然存在。)
随着新功能的添加或Django API或行为的变化,添加新功能的文档。
Django的文档与其代码保存在同一个源代码控制系统中。它生活在 docs 我们Git存储库的目录。每个在线文档都是存储库中的一个单独的文本文件。
您可以通过多种方式阅读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的开发版本(也就是主分支), docs/
目录包含所有文档。您可以更新您的Git结账以获取最新更改。
利用文本文档的一种低技术方法是使用Unix grep
在所有文档中搜索短语的实用程序。例如,这将显示您在任何Django文档中每次提到短语“max_size”:
$ grep -r max_length /path/to/django/docs/
...\> grep -r max_length \path\to\django\docs\
您可以按照几个步骤获取HTML文档的本地副本:
Django的文档使用了一个名为 Sphinx 从纯文本转换为HTML。您需要通过从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的Next的新功能的文档 feature release 。出于这个原因,值得指出的是,我们的政策是强调Django最近的变化和增加。
我们遵循此政策:
Https://docs.djangoproject.com/en/dev/上的开发文档来自主分支机构。这些文档对应于最新的功能版本,以及自那以后框架中添加/更改的任何功能。
当我们向Django的开发版本添加功能时,我们会在同一Git提交事务中更新文档。
为了区分文档中的功能更改/添加,我们使用短语:“Django Development Version中的新”来表示尚未发布的Django版本,或“X.Y版中的新”来表示已发布的版本。
然而,一旦Django的一个版本是 no longer supported ,该版本的文档将不会得到任何进一步的更新。
这个 main documentation web page 包括指向以前版本的文档的链接。确保您使用的文档版本与您正在使用的Django版本相对应!
7月 22, 2024