我们极其重视文档的一致性和可读性。毕竟，Django 是在需要快速发布新闻的环境下开发的！所以，我们像对待我们的代码一样对待我们的文档：我们期望尽可能频繁地更新它。
\n一般来说，文档会在以下两种情况时更新：
\n一般改进：通过更清晰的书写和更多示例，更正、修复文档错误，更好的解释功能。
新特性：自上一个版本发布后，添加到框架中的功能文档。
本节介绍文档作者如何以最有用和最不容易出错的方式修改文档。
\nDjango 文档可在 https://docs.djangoproject.com/ 以网页的形式阅读，但我们以一种更灵活的方式编辑它——一系列的文本文件。这些文件位于 Django 的每个发布分支的顶级目录 docs/ 下。
如果你想修改文档，请先从源码仓库获取开发版的 Django （参见 安装开发版）。开发版拥有最新最好的文档，就像它拥有最新最好的代码一样。我们也会在最新发布分支上提交针对文档的修复和优化（取决于提交者）。这是因为让最新版本的文档保持最新和正确是非常有利的（参见 不同版本文档间的区别）。
\nDjango 的文档使用 Sphinx 文档系统——基于 docutils。基本思想是将轻量格式话的纯文本转化为 HTML，PDF 或其它任意输出格式。
\nTo build the documentation locally, install Sphinx:
\nLinux / macOS
$ pip install Sphinx\nWindows
...\\> pip install Sphinx\nThen from the docs directory, build the HTML:
Linux / macOS
$ make html\nWindows
...\\> make.bat html\n编写文档前，你需要阅读 reStructuredText 指引。
\n本地构建的文档的主题会和 docs.djangoproject.com 上的不同。没事！如果你修改后的文档在本地看起来没啥问题，那么在网站上也会没问题。
\n文档被分为以下几个类别：
\n教程 通过几步手把手的教学帮助读者创建一个小玩意。
\n教程的目的是帮助读者尽可能早地实现一些有用的东西，以便给他们带来信心。
\nExplain the nature of the problem we're solving, so that the reader\nunderstands what we're trying to achieve. Don't feel that you need to begin\nwith explanations of how things work - what matters is what the reader does,\nnot what you explain. It can be helpful to refer back to what you've done and\nexplain afterwards.
\n主题指引 旨在在一个较高的层次介绍一个原则或主题。
\n链接至参考资料而不要重复它。使用示例时，不要不情愿解释对您而言非常基本的事物——它对别人而言可能需要解释。
\n提供背景信息有助于新人将主题和他们已知的东西联系起来。
\nReference guides contain technical reference for APIs.\nThey describe the functioning of Django's internal machinery and instruct in\nits use.
\nKeep reference material tightly focused on the subject. Assume that the\nreader already understands the basic concepts involved but needs to know or\nbe reminded of how Django does it.
\nReference guides aren't the place for general explanation. If you find\nyourself explaining basic concepts, you may want to move that material to a\ntopic guide.
\nHow-to guides are recipes that take the reader through\nsteps in key subjects.
\nWhat matters most in a how-to guide is what a user wants to achieve.\nA how-to should always be result-oriented rather than focused on internal\ndetails of how Django implements whatever is being discussed.
\nThese guides are more advanced than tutorials and assume some knowledge about\nhow Django works. Assume that the reader has followed the tutorials and don't\nhesitate to refer the reader back to the appropriate tutorial rather than\nrepeat the same material.
\nWhen using pronouns in reference to a hypothetical person, such as "a user with\na session cookie", gender neutral pronouns (they/their/them) should be used.\nInstead of:
\n他或她……使用他们。
him 或 her... 使用 them。
他的或她的……使用他们的。
his 或 hers... 使用 theirs。
himself 或 herself... 使用 themselves。
Try to avoid using words that minimize the difficulty involved in a task or\noperation, such as "easily", "simply", "just", "merely", "straightforward", and\nso on. People's experience may not match your expectations, and they may become\nfrustrated when they do not find a step as "straightforward" or "simple" as it\nis implied to be.
\n以下是整个文档中常用术语的一些格式指南：
\nDjango -- 当提及该框架时，大写Django。它仅在Python代码中和djangoproject.com徽标中使用小写字母。
email -- 无连字符。
MySQL, PostgreSQL, SQLite
SQL -- 当提及SQL时，预期的发音应该是“Ess Queue Ell”而不是“sequel”。因此，在诸如“Returns an SQL expression”之类的短语中，“SQL”前应该使用“an”而不是“a”。
Python -- 当提及该语言时大写。
realize, customize, initialize, etc. -- 使用美式的“ize”后缀，而不是“ise”。
subclass -- 它是一个没有连字符的单个单词，既作为动词（“子类模型”）又作为名词（“创建子类”）。
Web, World Wide Web, the Web -- 指万维网时注意Web总是大写。
website -- 用一个单词表示，不大写。
model (模型) -- 它不是大写的。
template -- 它不是大写的。
URLconf -- 使用了三个大写字母，在“conf”之前没有空格。
view -- 它不是大写的。
这些准则规定了我们的reST（reStructuredText）文档格式：
\nIn section titles, capitalize only initial words and proper nouns.
Wrap the documentation at 80 characters wide, unless a code example\nis significantly less readable when split over two lines, or for another\ngood reason.
The main thing to keep in mind as you write and edit docs is that the\nmore semantic markup you can add the better. So:
\nAdd ``django.contrib.auth`` to your ``INSTALLED_APPS``...\nIsn't nearly as helpful as:
\nAdd :mod:`django.contrib.auth` to your :setting:`INSTALLED_APPS`...\nThis is because Sphinx will generate proper links for the latter, which\ngreatly helps readers.
\nYou can prefix the target with a ~ (that's a tilde) to get just the\n"last bit" of that path. So :mod:`~django.contrib.auth` will just\ndisplay a link with the title "auth".
Use intersphinx to reference Python's and Sphinx'\ndocumentation.
Add .. code-block:: <lang> to literal blocks so that they get\nhighlighted. Prefer relying on automatic highlighting simply using ::\n(two colons). This has the benefit that if the code contains some invalid\nsyntax, it won't be highlighted. Adding .. code-block:: python, for\nexample, will force highlighting despite invalid syntax.
Use these heading styles:
\n===\nOne\n===\n\nTwo\n===\n\nThree\n-----\n\nFour\n~~~~\n\nFive\n^^^^\nUse :rfc: to reference RFC and and try to link to the\nrelevant section if possible. For example, use :rfc:`2324#section-2.3.2`\nor :rfc:`Custom link text <2324#section-2.3.2>`.
Besides Sphinx's built-in markup, Django's docs\ndefine some extra description units:
\nSettings:
\n.. setting:: INSTALLED_APPS\nTo link to a setting, use :setting:`INSTALLED_APPS`.
Template tags:
\n.. templatetag:: regroup\nTo link, use :ttag:`regroup`.
Template filters:
\n.. templatefilter:: linebreaksbr\nTo link, use :tfilter:`linebreaksbr`.
Field lookups (i.e. Foo.objects.filter(bar__exact=whatever)):
.. fieldlookup:: exact\nTo link, use :lookup:`exact`.
django-admin commands:
.. django-admin:: migrate\nTo link, use :djadmin:`migrate`.
django-admin command-line options:
.. django-admin-option:: --traceback\nTo link, use :option:`command_name --traceback` (or omit command_name\nfor the options shared by all commands like --verbosity).
Links to Trac tickets (typically reserved for patch release notes):
\n:ticket:`12345`\nDjango's documentation uses a custom console directive for documenting\ncommand-line examples involving django-admin.py, manage.py, python,\netc.). In the HTML documentation, it renders a two-tab UI, with one tab showing\na Unix-style command prompt and a second tab showing a Windows prompt.
For example, you can replace this fragment:
\nuse this command:\n\n.. code-block:: console\n\n $ python manage.py shell\nwith this one:
\nuse this command:\n\n.. console::\n\n $ python manage.py shell\nNotice two things:
\nYou usually will replace occurrences of the .. code-block:: console\ndirective.
You don't need to change the actual content of the code example. You still\nwrite it assuming a Unix-y environment (i.e. a '$' prompt symbol,\n'/' as filesystem path components separator, etc.)
The example above will render a code example block with two tabs. The first\none will show:
\n$ python manage.py shell\n(No changes from what .. code-block:: console would have rendered).
The second one will show:
\n...\\> py manage.py shell\nOur policy for new features is:
\n\n\nAll documentation of new features should be written in a way that\nclearly designates the features are only available in the Django\ndevelopment version. Assume documentation readers are using the latest\nrelease, not the development version.
\n
Our preferred way for marking new features is by prefacing the features'\ndocumentation with: ".. versionadded:: X.Y", followed by a mandatory\nblank line and an optional description (indented).
General improvements, or other changes to the APIs that should be emphasized\nshould use the ".. versionchanged:: X.Y" directive (with the same format\nas the versionadded mentioned above.
These versionadded and versionchanged blocks should be "self-contained."\nIn other words, since we only keep these annotations around for two releases,\nit's nice to be able to remove the annotation and its contents without having\nto reflow, reindent, or edit the surrounding text. For example, instead of\nputting the entire description of a new or changed feature in a block, do\nsomething like this:
.. class:: Author(first_name, last_name, middle_name=None)\n\n A person who writes books.\n\n ``first_name`` is ...\n\n ...\n\n ``middle_name`` is ...\n\n .. versionchanged:: A.B\n\n The ``middle_name`` argument was added.\nPut the changed annotation notes at the bottom of a section, not the top.
\nAlso, avoid referring to a specific version of Django outside a\nversionadded or versionchanged block. Even inside a block, it's often\nredundant to do so as these annotations render as "New in Django A.B:" and\n"Changed in Django A.B", respectively.
If a function, attribute, etc. is added, it's also okay to use a\nversionadded annotation like this:
.. attribute:: Author.middle_name\n\n .. versionadded:: A.B\n\n An author's middle name.\nWe can simply remove the .. versionadded:: A.B annotation without any\nindentation changes when the time comes.
Optimize image compression where possible. For PNG files, use OptiPNG and\nAdvanceCOMP's advpng:
$ cd docs\n$ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"`\n$ advpng -z4 `find . -type f -not -path "./_build/*" -name "*.png"`\nThis is based on OptiPNG version 0.7.5. Older versions may complain about the\n--strip all option being lossy.
For a quick example of how it all fits together, consider this hypothetical\nexample:
\nFirst, the ref/settings.txt document could have an overall layout\nlike this:
========\nSettings\n========\n\n...\n\n.. _available-settings:\n\nAvailable settings\n==================\n\n...\n\n.. _deprecated-settings:\n\nDeprecated settings\n===================\n\n...\nNext, the topics/settings.txt document could contain something like\nthis:
You can access a :ref:`listing of all available settings\n<available-settings>`. For a list of deprecated settings see\n:ref:`deprecated-settings`.\n\nYou can find both in the :doc:`settings reference document\n</ref/settings>`.\nWe use the Sphinx doc cross reference element when we want to\nlink to another document as a whole and the ref element when\nwe want to link to an arbitrary location in a document.
Next, notice how the settings are annotated:
\n.. setting:: ADMINS\n\nADMINS\n======\n\nDefault: ``[]`` (Empty list)\n\nA list of all the people who get code error notifications. When\n``DEBUG=False`` and a view raises an exception, Django will email these people\nwith the full exception information. Each member of the list should be a tuple\nof (Full name, email address). Example::\n\n [('John', 'john@example.com'), ('Mary', 'mary@example.com')]\n\nNote that Django will email *all* of these people whenever an error happens.\nSee :doc:`/howto/error-reporting` for more information.\nThis marks up the following header as the "canonical" target for the\nsetting ADMINS. This means any time I talk about ADMINS,\nI can reference it using :setting:`ADMINS`.
That's basically how everything fits together.
\n在提交文档前运行拼写检查是个不错的注意。你需要先装几个包：
\nThen from the docs directory, run make spelling. Wrong words (if any)\nalong with the file and line number where they occur will be saved to\n_build/spelling/output.txt.
If you encounter false-positives (error output that actually is correct), do\none of the following:
\nSurround inline code or brand/technology names with grave accents (`).
查找拼写检查程序发现的同义词。
如果，只是如果，你确定你的单词拼写是正确的——将其加入 docs/spelling_wordlist （请保持这个列表以字母顺序排列）。
查看 本地化 Django 文档，如果你想帮助我们将文档翻译成其它语言。
\ndjango-admin 手册页面Link to this heading#Sphinx can generate a manual page for the\ndjango-admin command. This is configured in\ndocs/conf.py. Unlike other documentation output, this man page should be\nincluded in the Django repository and the releases as\ndocs/man/django-admin.1. There isn't a need to update this file when\nupdating the documentation, as it's updated once as part of the release process.
To generate an updated version of the man page, run make man in the\ndocs directory. The new man page will be written in\ndocs/_build/man/django-admin.1.