看来你已经阅读了 介绍文档 ,而且决定继续使用Django。 前面我们只是概要性的介绍(实际上,即使你读了所有的介绍,也只看了整个文档的5%)。
所以下一步是什么呢?
我们是喜欢通过实践来学习。基于这一点,你应该开始动手你自己的项目。当你需要新的技能的时候,再回来查文档。
我们花了很多精力来让Django文档实用、易读、尽可能完备。 下面文档更多的是关于如何使用文档,以便于你可以最大化的利用它。
(是的,这篇文档是关于如何使用文档的。放心我们不会再为这篇文档的文档再写一篇文档了)
Django 的主要文档可以分解为几个用于满足不同需求的部分:
入门教程 是为刚接触Django或Web开发的人所设计的。 它并不包含深度的内容,它像是培养你如何使用Django的一种“感觉”。
主题指南 ,通过另一种方式,在Django的每一块做了深入讲解。 主题包括 模型系统, 模板索引 , 表单框架 等等。
这里可能是你最需要花时间的地方;如果你动手完成了这些指导文档的内容,那么你应该对Django非常熟悉了。
Web开发通常范围广,但是不深–问题会涉及很多领域。 我们写了一系列 使用指南 来回答常见的 “我该如何..?” 这类的问题。 这里你会发现关于 如何用Django生成PDF文档 , 如何写 通用模板标签 等等。
对于细节性的问题可以在 FAQ 中找到。
主题指南和使用指南没有完全覆盖到Django中得每个类、函数、方法—如果那样的话会太多,不利于学习。 实际上,每个类、函数、方法还有模块的细节在 参考指南 中。 那里才是当你需要查找函数细节或是其他什么细节的地方。
最后,有一些”特殊”的文档通常与大多数开发者无关。包括 版本记录 和 内部文档 是写给那些想贡献代码到Django的人,和一些 不好分类杂散 的文档。
像Django代码一样通常每天都在开发和改进,我们的文档是持续改进的。我们改进文档的原因:
Django 文档和代码一样是有版本控制的。它在我们 Git 仓库的 docs 目录下。每篇文章在仓库中是一个独立的文本文件。
你可以通过几种不同方式阅读Django文档。以下用优先顺序排列:
最新版本的Django文档来源于右边网址 https://docs.djangoproject.com/en/dev/ 。 这些HTML页面是由源控制的文本本件自动产生的。这意味着他们反映了Django“最新和最好”的方面——包括最新的更正和新添加的内容, 以及对于可能仅针对Django最新版本的用户开放的新特性的讨论。(见下文“版本之间的差异”)
我们鼓励您在 ticket system 中提交更改、更正或者建议以促进文档的改善。 Django 的开发者会主动查看工单系统,并且使用你的反馈意见来改善文档。
注意,不管怎样,工单应该非常明确的是和文档相关的,而不是问一些技术支持的问题。如果你需要特别的 Django 帮助, 试试 Django 用户组邮件列表 或者 #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 格式的文档:
Django 的文档用了一个叫做 Sphinx 的文档系统来从纯文本转换到 HTML。你需要安装 Sphinx,
通过 Sphinx 网站下载安装包,或者通过 pip
方式安装。
$ 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 开发版增加的一些特性。因此,我们的策略是保留各种版本的开发文档。
我们遵从的策略:
10月 29, 2021