Apa yang akan dibaca selanjutnya¶
Jadi anda telah membaca semua bahan perkenalan dan telah memutuskan anda akan tetap menggunakan Django. Kami hanya menggores permukaan dengan pengenalan ini (kenyataannya, jika anda telah membaca setiap kata tunggal, anda telah membaca tentang 5% dari dokumentasi keseluruhan).
Lalu apa selanjutnya?
Baiklah, kami selalu penggemar besar dari belajar berdasarkan melakukan. Pada titik ini anda harus cukup tahu untuk mulai proyek dari milik anda dan mulai bermain-main. Ketika anda butuh belajar trik baru, datang kembali ke dokumentasi.
Kami telah menaruh banyak usaha dalam membuat dokumentasi Django berguna, mudah dibaca dan mungkin lengkap. Sisa dokumen ini menjelaskan lebih tentang bagaimana dokumentasi bekerja sehingga anda dapat mendapatkan sebagian besar dari itu.
(Ya, dokumentasi ini tentang dokumentasi. Sisanya dijamin kami tidak punya rencana untuk menulis dokumen tentang bagaimana membaca dokumen tentang dokumentasi.)
Menemukan dokumentasi¶
Django mendapatkan banyak dokumentasi – hampir 450,000 kata dan berhitung – jadi menemukan apa yang anda butuhkan terkadang butuh trik. Sedikit tempat bagus untuk mulai adalah Pencarian Halaman dan the Indeks.
Atau anda hanya menjelajah sekitar!
Bagaimana dokumentasi diatur¶
Dokumentasi utama Django dipecah menjadi “potongan” rancangan untuk mengisi kebutuhan berbeda:
bahan perkenalan dirancang untuk orang baru ke Django – atau untuk pengembang Jaringan secara umum. Dia tidak mencangkup apapun lebih dalam, tetapi sebagai gantinya memberikan ikhtisar tingkatan tinggi dari bagaimana mengembangkan di “rasa” Django.
panduan topik, di tangan lain, gali lebih dalam ke bagian tersendiri dari Django. Terdapat panduan lengkap ke sistem model Django, mesin cetakan, kerangka bentuk, dan banyak lagi.
Ini mungkin dimana anda ingin menghabiskan banyak waktu anda; jika anda bekerja jalan anda melalui panduan ini anda harus keluar mengetahui hampir segala sesuatu yang ada untuk diketahui tentang Django.
Pengembangan jaringan sering melebar, tidak dalam – masalah menjangkau banyak ranah. Kami telah menulis sekumpulan how-to guides yang menjawab umum pertanyaan “Bagaimana Saya ...?”. Disini anda akan menemukan informasi tentang membangkitkan PDF dengan Django, menulis penyesuaian etiket cetakan, dan lagi.
Jawaban pertanyaan sangat umum dapat ditemukan di FAQ.
Panduan dan bagaimana-untuk tidak mencangkup setiap kelas tunggal, fungsi, dan cara tersedia di Django – itu akan besar sekali ketika anda mencoba belajar. Sebagai gantinya, rincian tentang kelas, fungsi, cara dan modul tersendiri terjaga di reference. Ini adalah dimana anda akan merubah menemukan rincian dari fungsi tertentu atau apapun anda butuhkan.
Jika anda tertarik menyebarkan sebuah proyek untuk penggunaan umum, dokumen kami mempunyai beberapa panduan untuk beragam pengaturan pengembangan sama halnya daftar centang penyebaran untuk sesuatu anda akan butuh untuk dipikirkan.
Akhirnya, terdapat beberapa dokumentasi “khusus” buka biasanya berhubungan ke kebanyakan pengembang. Ini termasuk catatan terbitan dan dokumentasi internal untuk yang ingin menambahkan kode ke Django itu sendiri, dan sebuah sedikit hal lainnya yang hanya tidak cocok ditempat lain.
Bagaimana dokumentasi diperbaharui¶
Hanya sebagai basis kode Django dikembangkan dan diperbaiki pada permulaan harian, dokumentasi kami terus-menerus diperbaiki. Kami memperbaiki dokumentasi untuk beberapa alasan:
Untuk membuat isi tetap, seperti pembetulan tata bahasa/kesalahan ketik.
Untuk menambahkan informasi dan/atau contoh pada bagian yang ada yang butuh diperluas.
Pada dokumen fitur Django yang belum didokumentasikan. (Daftar seperti fitur itu menyusut tapi tetap ada.)
Untuk menambahkan dokumentasi untuk fitur baru sebagai fitur baru ditambahkan, atau API Django atau perubahan kebiasaan.
Dokumentasi Django menjaga di sistem kendali sumber sama sebagai kodenya. Itu berada di direktori docs dari gudang Git kami. Setiap dokumentasi daring adalah berkas teks terpisah di gudang.
Dimana mendapatkannya¶
Anda dapat membaca dokumentasi Django dalam beberapa cara. Mereka adalah, urutan pilihan:
Di Jaringan¶
Versi paling terkini dari dokumentasi Django berada di https://docs.djangoproject.com/en/dev/. Halaman HTML ini dibangkitkan otomatis dari berkas teks di kendali sumber. Itu berarti mereka mencerminkan “terakhir dan terhebat” di Django – mereka menyertakan pembenaran dan penambahan paling terakhir, dan mereka mengobrol fitur Django terakhir, yang mungkin hanya tersedia ke pengguna dari versi pengembangan Django. (Lihat “Perbedaan diantara versi” dibawah.)
Kami mendorong anda untuk membantu perbaikan dokumen dengan mengajukan perubahan, pembenaran dan saran di sistem tiket. Pengembang Django secara aktif mengawasi sistem tiket dan menggunakan umpan balik anda untuk memperbaiki dokumentasi untuk semua orang.
Catat, bagaimanapun, tiket itu harus secara eksplisit berhubungan ke dokumentasi, dari pada menanyakan pertanyaan dukunan-teknis luas. Jika anda butuh bantuan dengan pengaturan Django khususnya, coba django-users daftar penyuratan atau #django IRC channel.
Dalam teks polos¶
Untuk membaca tanpa jaringan, atau hanya untuk kenyamanan, anda dapat membaca dokumentasi Django di teks polos.
Jika anda menggunakan terbitan resmi Django, catat bahwa paket terkompres (tarball) dari kode termasuk direktori docs/, yang mengandung semua dokumentasi untuk terbitan tersebut.
Jika anda menggunakan versi pengembangan Django (alias “trunk”), catat bahwa direktori docs/ mengandung semua dokumentasi. Anda dapat memperbaharui Git checkout anda untuk mendapatkan perubahan terakhir.
Hanya jalan teknik-rendah dari mengambil keuntungan dari teks dokumentasi dengan menggunakan alat grep Unix untuk mencari frase di semua dokumentasi. Sebagai contoh, ini akan menunjukkan anda setiap sebutan dari frase “max_length” di dokumen Django:
$ grep -r max_length /path/to/django/docs/
Sebagai HTML, secara lokal¶
Anda dapat mendapatkan salinan lokal dari dokumentasi HTML mengikuti sedikit langkah mudah:
Dokumentasi Django menggunakan sebuah sistem disebut Sphinx untuk merubah dari teks polos ke HTML. Anda akan butuh memasang Sphinx dengan salah satu mengunduh dan memasang paket dari situs jaringan Sphinx, atau dengan
pip:$ pip install SphinxKemudian, hanya gunakan
Makefiledisertakan untuk mengubah dokumentasi kedalam HTML:$ cd path/to/django/docs $ make html
Anda akan butuh GNU Make memasang untuk ini.
Jika anda berada di Windows anda dapat cara lain menggunakan berkas kumpulan disertakan:
cd path\to\django\docs make.bat htmlDokumentasi HTML akan ditempatkan di
docs/_build/html.
Perbedaan diantara versi¶
Seperti sebelumnya disebutkan, dokumentasi teks di gudang Git kami mengandung “terakhir dan terhebat” perubahan dan penambahan. Perubahan ini sering menyertakan dokumentasi dari fitur baru ditambahkan di versi pengembangan Django – versi Git (“trunk”) Django. Untuk alasan tersebut, itu layak menunjuk kebijakan kami dalam menjaga ketat dokumentasi untuk beragam versi dari kerangka.
Kami mengikuti kebijakan ini:
Dokumentasi utama yang berada di djangoproject.com merupakan versi HTML dari dokumentasi terbaru di Git. Dokumentasi ini akan mengikuti rilis terbaru dari Django, plus fitur-fitur baru yang telah kami tambahkan/ubah di dalam framework sejak rilis terakhir.
Ketika kami menambah fitur ke versi pengembangan Django, kami mencoba untuk memperbaharui dokumentasi di transaksi penyerahan Git yang sama.
Untuk membedakan perubahan/penambahan fitur di dokumen, kami menggunakan frase: “Baru di versi X.Y”, menjadi X.Y versi terbitan selanjutnya (karenanya, satu sedang dikembangkan).
Dokumentasi perbaikan dan peningkatan mungkin ditautkan ke cabang terbitan terakhir, kebijaksanaan dari penyerah, bagaimanapun, sekali versi Django ref:tidak lagi didukung<backwards-compatibility-policy>, versi tersebut dari dokumen tidak akan mendapatkan pembaharuan lebih lanjut.
halaman Jaringan dokumentasi utama menyertakan tautan ke dokumentasi untuk semua versi sebelumnya. Pastikan anda menggunakan versi dari dokumen terhubung ke versi Django anda sedang gunakan!
