次に読むべきこと
これで、の紹介資料をすべて読み、Djangoを使い続けることにしました。 このイントロで表面をかじっただけです（実際、すべての単語を読んだ場合は、ドキュメント全体の約5 % oを読んだことになります）。
では、次は何ですか？
ええと、私たちはいつもやって学ぶことの大ファンでした。 この時点で、あなたはあなた自身のプロジェクトを開始し、浮気を始めるのに十分な知識を持っているはずです。 新しいトリックを学ぶ必要があるので、ドキュメントに戻ってください。
私たちは、Djangoのドキュメントを有用で、明確で、可能な限り完全なものにするために多大な努力を払ってきました。 このドキュメントの残りの部分では、ドキュメントを最大限に活用できるように、ドキュメントがどのように機能するかについて詳しく説明します。
（はい、これはドキュメントに関するドキュメントです。 ドキュメントに関するドキュメントの読み方についてのドキュメントを作成する予定はありませんので、ご安心ください。）
ドキュメントの検索
Djangoにはロットのドキュメントがあり、約450,000語と数えられているため、必要なものを見つけるのが難しい場合があります。 開始するのに適した場所は、インデックスです。 また、組み込みの検索機能を使用することをお勧めします。
または、ただ閲覧することもできます！
ドキュメントの構成方法
Djangoのメインドキュメントは、さまざまなニーズを満たすように設計された「チャンク」に分割されています。
入門資料は、Djangoを初めて使用する人、またはWeb開発全般を初めて使用する人向けに設計されています。 詳細については何も説明していませんが、代わりにDjangoでの開発がどのように「感じられる」かについての概要を説明しています。
一方、トピックガイドは、Djangoの個々の部分を深く掘り下げます。 Djangoのモデルシステム、テンプレートエンジン、フォームフレームワークなどの完全なガイドがあります。
これはおそらく、ほとんどの時間を過ごしたい場所です。 これらのガイドを読み進めると、Djangoについて知っておくべきことのほとんどすべてを知っているはずです。
多くの場合、Web開発は広範であり、深くはありません。問題は多くのドメインにまたがっています。 一般的な「どうすれば…？」に答えるハウツーガイドのセットを作成しました。 質問。 ここでは、 Djangoを使用したPDFの生成、カスタムテンプレートタグの作成などに関する情報を見つけることができます。
本当に一般的な質問への回答は、 FAQ にもあります。
ガイドとハウツーは、Djangoで利用可能なすべてのクラス、関数、およびメソッドを網羅しているわけではありません。これは、学習しようとしているときに圧倒されるでしょう。 代わりに、個々のクラス、関数、メソッド、およびモジュールに関する詳細は、リファレンスに保持されます。 ここで、特定の機能の詳細や必要なものを見つけることができます。
プロジェクトを公開するためにデプロイすることに興味がある場合、ドキュメントには、さまざまなデプロイ設定に関するいくつかのガイドと、考慮する必要のあるいくつかの事項に関するデプロイメントチェックリストがあります。
最後に、通常はほとんどの開発者に関係のない「特殊な」ドキュメントがいくつかあります。 これには、Django自体にコードを追加したい人のためのリリースノートと内部ドキュメント、および他の場所に収まらない他のいくつかのが含まれます。
ドキュメントの更新方法
Djangoコードベースが毎日開発および改善されているように、ドキュメントも一貫して改善されています。 いくつかの理由でドキュメントを改善します。
- 文法/タイプミスの修正など、コンテンツを修正するため。
- 拡張が必要な既存のセクションに情報や例を追加するため。
- まだ文書化されていないDjango機能を文書化するため。 （そのような機能のリストは縮小していますが、それでも存在します。）
- 新しい機能が追加されたとき、またはDjango APIや動作が変更されたときに、新しい機能のドキュメントを追加するため。
Djangoのドキュメントは、そのコードと同じソース管理システムに保持されています。 これは、Gitリポジトリの：source： `docs` ディレクトリにあります。 オンラインの各ドキュメントは、リポジトリ内の個別のテキストファイルです。
どこで入手できますか
Djangoのドキュメントはいくつかの方法で読むことができます。 それらは、優先順に次のとおりです。
ウェブ上で
Djangoドキュメントの最新バージョンは、 https://docs.djangoproject.com/en/dev/にあります。 これらのHTMLページは、ソース管理のテキストファイルから自動的に生成されます。 つまり、Djangoの「最新かつ最高」を反映しています。最新の修正と追加が含まれており、Django開発バージョンのユーザーのみが利用できる最新のDjango機能について説明しています。 （以下のバージョン間の違いを参照してください。）
チケットシステムで変更、修正、提案を送信して、ドキュメントの改善にご協力いただくことをお勧めします。 Django開発者はチケットシステムを積極的に監視し、フィードバックを使用してすべての人のドキュメントを改善します。
ただし、チケットは、幅広いテクニカルサポートの質問をするのではなく、ドキュメントに明示的に関連している必要があることに注意してください。 特定のDjangoセットアップについてサポートが必要な場合は、代わりに django-users メーリングリストまたは #djangoIRCチャネルを試してください。
プレーンテキスト
オフラインで読むため、または単に便宜上、Djangoのドキュメントをプレーンテキストで読むことができます。
Djangoの公式リリースを使用している場合、コードのzipパッケージ（tarball）には、そのリリースのすべてのドキュメントを含むdocs/ディレクトリが含まれています。
Djangoの開発バージョン（別名メインブランチ）を使用している場合、docs/ディレクトリにはすべてのドキュメントが含まれています。 Gitチェックアウトを更新して、最新の変更を取得できます。
テキストドキュメントを利用するローテクな方法の1つは、Unix grepユーティリティを使用してすべてのドキュメント内のフレーズを検索することです。 たとえば、これにより、Djangoドキュメントでの「max_length」というフレーズの各言及が表示されます。
HTMLとして、ローカル
いくつかの手順に従って、HTMLドキュメントのローカルコピーを取得できます。
Djangoのドキュメントでは、 Sphinx というシステムを使用して、プレーンテキストからHTMLに変換しています。 Sphinx Webサイトからパッケージをダウンロードしてインストールするか、
pipを使用して、Sphinxをインストールする必要があります。次に、付属の
Makefileを使用して、ドキュメントをHTMLに変換します。$ cd path/to/django/docs $ make htmlこれには、 GNU Make をインストールする必要があります。
Windowsを使用している場合は、代わりに付属のバッチファイルを使用できます。
cd path\to\django\docs make.bat htmlHTMLドキュメントは
docs/_build/htmlに配置されます。
バージョン間の違い
Gitリポジトリのメインブランチにあるテキストドキュメントには、「最新かつ最大の」変更と追加が含まれています。 これらの変更には、Djangoの次の機能リリースを対象とした新機能のドキュメントが含まれています。 そのため、Djangoへの最近の変更と追加を強調するポリシーを指摘する価値があります。
私たちはこのポリシーに従います：
- https://docs.djangoproject.com/en/dev/の開発ドキュメントは、メインブランチからのものです。 これらのドキュメントは、最新の機能リリースに加えて、それ以降にフレームワークで追加/変更された機能に対応しています。
- Djangoの開発バージョンに機能を追加すると、同じGitコミットトランザクションでドキュメントが更新されます。
- ドキュメント内の機能の変更/追加を区別するために、まだリリースされていないバージョンのDjangoの場合は「Newin Django Development version」、リリースされたバージョンの場合は「New in versionXY」というフレーズを使用します。
- ドキュメントの修正と改善は、コミッターの裁量で最後のリリースブランチにバックポートされる場合がありますが、Djangoのバージョンがサポートされなくなると、そのバージョンのドキュメントはそれ以上更新されません。 。
- メインドキュメントWebページには、以前のバージョンのドキュメントへのリンクが含まれています。 使用しているDjangoのバージョンに対応するバージョンのドキュメントを使用していることを確認してください！
