Итак, вы прочитали весь вводный материал и решили, что хотите продолжать использовать Django. Мы коснулись только поверхности документации по Django (на самом деле, если вы прочитали каждое слово, вы пока освоили менее 5% от общего объема документации).
Итак, что дальше?
Мы всегда были большими поклонниками обучения на практике. На данный момент вы должны знать достаточно, чтобы создать собственный проект и начать с ним разбираться. Как только вам понадобится научиться новым хитростям, возвращайтесь к документации.
We’ve put a lot of effort into making Django’s documentation useful, clear and as complete as possible. The rest of this document explains more about how the documentation works so that you can get the most out of it.
(Да, это документация о документации. Будьте уверены, мы не планируем писать документ о том, как прочитать документ о документации.)
Документация Django очень большая – почти 450,000 слов – поэтому найти необходимое может оказаться трудной задачей. В этом случае вам поможет Поиск и Алфавитный указатель.
Или вы можете просто полистать!
Основная документация Django разбита на «блоки», предназначенные для удовлетворения различных потребностей:
The introductory material is designed for people new to Django – or to Web development in general. It doesn’t cover anything in depth, but instead gives a high-level overview of how developing in Django «feels».
The topic guides, on the other hand, dive deep into individual parts of Django. There are complete guides to Django’s model system, template engine, forms framework, and much more.
На эти вещи вы, наверное, захотите потратить большую часть своего времени, если вы начали работать с этим руководством, не зная практически ничего о Django.
Веб-разработка часто широко, но не глубоко, затрагивает проблемы из многих областей. Мы написали множество практических руководств, которые отвечают на вопросы вида «Как мне …?». Здесь вы найдете сведения о создании PDF-файлов с Django, написании шаблонных тегов и многом другом.
Ответы на часто задаваемые вопросы можно найти в FAQ.
Руководства и how-to не покрывают каждый класс, функцию и метод, доступные в Django - это негативно сказалось бы на изучении. Вместо этого, информация об отдельных классах, функциях, методах и модулях хранится в Справочнике API. В нем вы можете найти детали той или иной функции или то, что Вам нужно.
Если вы хотите развернуть проект на севере, документация содержит несколько гайдов для различных вариантов установки, также deployment checklist содержит некоторую полезную информацию.
Finally, there’s some «specialized» documentation not usually relevant to most developers. This includes the release notes and internals documentation for those who want to add code to Django itself, and a few other things that don’t fit elsewhere.
Подобно тому, как базовый код Django ежедневно развивается и совершенствуется, наша документация постоянно улучшается. Мы улучшаем документацию по нескольким причинам:
Django’s documentation is kept in the same source control system as its code. It lives in the docs directory of our Git repository. Each document online is a separate text file in the repository.
Вы можете читать Django документацию несколькими путями. В порядке предпочтения:
The most recent version of the Django documentation lives at https://docs.djangoproject.com/en/dev/. These HTML pages are generated automatically from the text files in source control. That means they reflect the «latest and greatest» in Django – they include the very latest corrections and additions, and they discuss the latest Django features, which may only be available to users of the Django development version. (See Различия между версиями below.)
Мы поощряем улучшение документации через внесение изменений, исправлений и предложений в ticket system. Django разработчики активно наблюдают за системой тикетов и используют обратную связь от вас для улучшения документации для каждого.
Однако следует отметить, что тикеты должны быть заведены по существу, а не обсуждать вопросы по технической поддержке широкого характера. Если Вам нужна помощь с вашей индивидуальной установкой Django, воспользуйтесь рассылкой django-users или #django IRC channel
Для чтения в автономном режиме, или просто для удобства, вы можете читать Django документацию в текстовом формате.
If you’re using an official release of Django, the zipped package (tarball) of
the code includes a docs/ directory, which contains all the documentation
for that release.
If you’re using the development version of Django (aka the master branch), the
docs/ directory contains all of the documentation. You can update your
Git checkout to get the latest changes.
При помощи утилиты grep можно сделать поиск заданной фразы по всей документации. Например, эта команда выдаст каждое упоминание фразы «max_length» во всей документации Django:
$ grep -r max_length /path/to/django/docs/
...\> grep -r max_length \path\to\django\docs\
You can get a local copy of the HTML documentation following a few steps:
Документация Django использует систему под названием Sphinx для преобразования обычного текста в HTML. Вам нужно установить Sphinx веб-сайта Сфинкс или при помощи pip:
$ python -m pip install Sphinx
...\> py -m pip install Sphinx
Then, use the included Makefile to turn the documentation into HTML:
$ cd path/to/django/docs
$ make html
Вам понадобится GNU Make, установленный для этого.
Если вы используете Windows, также можно использовать включенный batch файл:
cd path\to\django\docs
make.bat html
HTML документация будет размещена в docs/_build/html.
The text documentation in the master branch of the Git repository contains the «latest and greatest» changes and additions. These changes include documentation of new features targeted for Django’s next feature release. For that reason, it’s worth pointing out our policy to highlight recent changes and additions to Django.
Мы следуем следующей политике:
июн. 04, 2020