所以你读了所有的 introductory material 并且决定继续使用django。我们只不过是用这个简介来勾勒了表面(事实上,如果你读过每一个单词,你已经读了大约5%的文档)。
那么接下来呢?
好吧,我们一直都是“实践学习”的忠实粉丝。在这一点上,你应该有足够的知识来启动你自己的项目并开始胡闹。当您需要学习新技巧时,请返回文档。
我们花了大量的精力使Django的文档尽可能有用、清晰和完整。本文档的其余部分将详细解释文档如何工作,以便您可以充分利用它。
(是的,这是有关文档的文档。请放心,我们不打算写关于如何阅读文档的文档。)
詹戈的A lot 文档——将近45万字,而且还在计数——所以找到你需要的东西有时会很棘手。一个好的开始是 索引 . 我们还建议使用内置搜索功能。
或者你可以随便看看!
Django的主要文档分为“块”,旨在满足不同的需求:
这个 introductory material 是为Django--或一般的Web开发新手--设计的。它没有深入介绍任何内容,而是提供了在Django中进行开发的“感觉”的高级概述。
这个 topic guides 另一方面,潜入 Django 的各个部分。有完整的Django指南 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功能。(此类功能的列表正在缩小,但仍然存在。)
在添加新功能或DjangoAPI或行为改变时为新功能添加文档。
Django的文档与代码保存在同一个源代码控制系统中。它生活在 docs Git存储库的目录。每个联机文档都是存储库中的单独文本文件。
您可以通过多种方式阅读Django文档。按照优先顺序:
Django文档的最新版本位于https://docs.djangoproject.com/en/dev/。这些HTML页是从源代码管理中的文本文件自动生成的。这意味着它们反映了Django中的“最新和最伟大”,其中包括最新的更正和添加,并讨论了最新的Django功能,这些功能可能只对Django开发版本的用户可用。(见 版本之间的差异 下面)
我们鼓励您通过在 ticket system . Django开发人员积极监控票务系统,并利用您的反馈为每个人改进文档。
但是请注意,票据应该明确地与文档相关,而不是问广泛的技术支持问题。如果您需要特定Django设置的帮助,请尝试Django用户邮件列表或 #django IRC channel 相反。
为了离线阅读,或者只是为了方便起见,您可以阅读纯文本形式的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文档的本地副本:
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的Next的新功能的文档 feature release 。出于这个原因,值得指出的是,我们的政策是强调Django最近的变化和增加。
我们遵循以下政策:
Https://docs.djangoproject.com/en/dev/上的开发文档来自主分支机构。这些文档对应于最新的功能版本,以及自那以后框架中添加/更改的任何功能。
当我们向django的开发版本添加特性时,我们在同一个git commit事务中更新文档。
为了区分文档中的功能更改/添加,我们对尚未发布的django版本使用短语“在django开发版本中是新的”,或对已发布的版本使用短语“在x.y版本中是新的”。
然而,一旦Django的一个版本是 no longer supported ,该版本的文档将不会得到任何进一步的更新。
这个 main documentation web page 包括指向以前版本的文档的链接。确保您使用的文档版本与您正在使用的Django版本相对应!
12月 18, 2023