Aplikasi admindocs Django menarik dokumentasi dari docstring dari model, tampilan etiket cetakan, dan penyaring cetakan untuk aplikasi apapun di INSTALLED_APPS dan membuat dokumentasi itu tersedia dari Django admin.
Untuk mengaktifkan admindocs, anda akan butuh melakukan berikut:
Tambah django.contrib.admindocs ke INSTALLED_APPS anda.
Add path('admin/doc/', include('django.contrib.admindocs.urls')) to\nyour urlpatterns. Make sure it's included before the\n'admin/' entry, so that requests to /admin/doc/ don't get\nhandled by the latter entry.
Pasang modul Python docutils (http://docutils.sf.net/).
Pilihan: Menggunakan Bookmark admindoc membutuhkan django.contrib.admindocs.middleware.XViewMiddleware untuk dipasang.
Sekali langkah-langkah tersebut lengkap, anda dapat mulai menjelajah dokumentasi dengan pergi ke antarmuka admin anda dan mengklik tautan "Documentation" di atas kanan halaman.
\nMarkah khusus beikur dapat digunakan di docstring anda untuk dengan mudah membuat hyperlink ke komponen lain:
\nKomponen Django | \nPeran reStructuredText | \n
|---|---|
Model | \n
| \n
View | \n
| \n
Tag templat | \n
| \n
Filter templat | \n
| \n
Templat | \n
| \n
Bagian model dari halaman admindoc menggambarkan setiap model di sistem bersama dengan semua bidang dan metode tersedia pada itu. Hubungan ke model lain muncul sebagaihyperlink. Gambaran ditarik dari atribut help_text pada bidang atau dari docstring pada metode model.
Sebuah model dengan dokumentasi berguna mungkin terlihat seperti ini:
\nclass BlogEntry(models.Model):\n """\n Stores a single blog entry, related to :model:`blog.Blog` and\n :model:`auth.User`.\n """\n slug = models.SlugField(help_text="A short label, generally used in URLs.")\n author = models.ForeignKey(\n User,\n models.SET_NULL,\n blank=True, null=True,\n )\n blog = models.ForeignKey(Blog, models.CASCADE)\n ...\n\n def publish(self):\n """Makes the blog entry live on the site."""\n ...\nSetiap URL di situs anda mempunyai masukan terpisah di halaman admindocs, dan mengklik pada URL yang diberikan akan menunjukkan anda tampilan berhubungan. Hal-hal membantu anda dapat dokumentasikan di docstring fungsi tampilan anda termasuk:
Sebuah gambaran singkat dari apa yang tampilan lakukan.
konteks, atau daftar dari variabel tersedia di cetakan tampilan.
Nama dari cetakan atau cetakan-cetakan yang digunakan untuk tampilan itu.
Sebagai contoh:
\nfrom django.shortcuts import render\n\nfrom myapp.models import MyModel\n\ndef my_view(request, slug):\n """\n Display an individual :model:`myapp.MyModel`.\n\n **Context**\n\n ``mymodel``\n An instance of :model:`myapp.MyModel`.\n\n **Template:**\n\n :template:`myapp/my_template.html`\n """\n context = {'mymodel': MyModel.objects.get(slug=slug)}\n return render(request, 'myapp/my_template.html', context)\nSelagi admindocs tidak menyertakan tempat untuk cetakan dokumen oleh mereka sendiri, jika anda menggunakan sintaksis :template:`path/to/template.html` di sebuah docstring halaman hasil akan memeriksa jalur dari cetakan itu dengan template loaders Django. Ini dapat menjadi cara mudah memeriksa jika cetakan ditentukan ada dan untuk menunjukkan dimana pada sistem berkas cetakan itu disimpan.
Satu bookmarklet tersedia dari halaman admindocs:
Buka dari laman apa saja ke laman dokumentasi untuk view yang menghasilkan laman tersebut.
\nMenggunakan bookmark ini mewajibkan bahwa XViewMiddleware dipasang dan bahwa anda masuk kedalam Django admin sebagai sebuah User dengan is_staff disetel menjadi True.