Django 2.1 - The Django admin documentation generator

Django व्यवस्थापक प्रलेखन जनरेटर




django

Django व्यवस्थापक प्रलेखन जनरेटर

Django के admindocs ऐप INSTALLED_APPS में किसी भी ऐप के लिए मॉडल, व्यू, टेम्प्लेट टैग और टेम्प्लेट के admindocs से प्रलेखन खींचता है और उस दस्तावेज़ को Django admin से उपलब्ध कराता है।

अवलोकन

प्रवेश को सक्रिय करने के लिए, आपको निम्नलिखित कार्य करने होंगे:

  • अपने INSTALLED_APPS admindocs जोड़ें।
  • अपने urlpatterns path('admin/doc/', include('django.contrib.admindocs.urls')) करें। सुनिश्चित करें कि इसे 'admin/' प्रविष्टि से पहले शामिल किया गया है, ताकि बाद के प्रविष्टि द्वारा /admin/doc/ से अनुरोध न किया जाए।
  • डॉक्यूटिल्स पायथन मॉड्यूल ( http://docutils.sf.net/ ) स्थापित करें।
  • वैकल्पिक: एडमिंडोस्क बुकमार्क का उपयोग करने के लिए django.contrib.admindocs.middleware.XViewMiddleware स्थापित करने की आवश्यकता होती है।

एक बार जब वे चरण पूरे हो जाते हैं, तो आप अपने व्यवस्थापक इंटरफ़ेस पर जाकर और पृष्ठ के ऊपरी दाएँ भाग में "दस्तावेज़" लिंक पर क्लिक करके दस्तावेज़ ब्राउज़ करना शुरू कर सकते हैं।

प्रलेखन सहायकों

निम्नलिखित विशेष मार्कअप का उपयोग आपके डॉकस्ट्रिंग्स में आसानी से अन्य घटकों के लिए हाइपरलिंक बनाने के लिए किया जा सकता है:

Django घटक reStructuredText भूमिकाएँ
मॉडल के :model:`app_label.ModelName`
दृश्य :view:`app_label.view_name`
टेम्प्लेट टैग :tag:`tagname`
खाका फिल्टर :filter:`filtername`
टेम्पलेट्स :template:`path/to/template.html`

मॉडल संदर्भ

admindocs पृष्ठ के मॉडल अनुभाग में सिस्टम पर प्रत्येक मॉडल और उस पर उपलब्ध सभी तरीकों के साथ वर्णन किया गया है। अन्य मॉडलों के संबंध हाइपरलिंक के रूप में दिखाई देते हैं। फ़ील्ड पर या मॉडल विधियों पर help_text से help_text विशेषताओं से विवरण खींचे जाते हैं।

उपयोगी प्रलेखन वाला एक मॉडल इस तरह दिख सकता है:

class BlogEntry(models.Model):
    """
    Stores a single blog entry, related to :model:`blog.Blog` and
    :model:`auth.User`.
    """
    slug = models.SlugField(help_text="A short label, generally used in URLs.")
    author = models.ForeignKey(
        User,
        models.SET_NULL,
        blank=True, null=True,
    )
    blog = models.ForeignKey(Blog, models.CASCADE)
    ...

    def publish(self):
        """Makes the blog entry live on the site."""
        ...

संदर्भ देखें

आपकी साइट के प्रत्येक URL में प्रवेश पृष्ठ में एक अलग प्रविष्टि है, और दिए गए URL पर क्लिक करने से आपको संबंधित दृश्य दिखाई देगा। आपके विचार समारोह के दस्तावेज़ों में जिन उपयोगी चीज़ों को आप शामिल कर सकते हैं, उनमें शामिल हैं:

  • दृश्य क्या करता है का एक संक्षिप्त विवरण।
  • संदर्भ , या दृश्य के टेम्पलेट में उपलब्ध चर की एक सूची।
  • उस दृश्य के लिए उपयोग किए जाने वाले टेम्पलेट या टेम्पलेट्स का नाम।

उदाहरण के लिए:

from django.shortcuts import render

from myapp.models import MyModel

def my_view(request, slug):
    """
    Display an individual :model:`myapp.MyModel`.

    **Context**

    ``mymodel``
        An instance of :model:`myapp.MyModel`.

    **Template:**

    :template:`myapp/my_template.html`
    """
    context = {'mymodel': MyModel.objects.get(slug=slug)}
    return render(request, 'myapp/my_template.html', context)

टेम्प्लेट टैग और फ़िल्टर संदर्भ

टैग और फ़िल्टर admindocs अनुभाग उन सभी टैग और फ़िल्टर का वर्णन करते हैं जो Django के साथ आते हैं (वास्तव में, अंतर्निहित टैग संदर्भ और अंतर्निहित फ़िल्टर संदर्भ प्रलेखन सीधे उन पृष्ठों से आते हैं)। आपके द्वारा बनाए गए या तीसरे पक्ष के ऐप द्वारा बनाए गए किसी भी टैग या फ़िल्टर इन वर्गों में भी दिखाई देंगे।

खाका संदर्भ

जब आप अपने द्वारा टेम्पलेट का दस्तावेज रखने के लिए जगह नहीं देते हैं, यदि आप :template:`path/to/template.html` उपयोग करते हैं :template:`path/to/template.html` परिणामी पृष्ठ पर एक docstring में :template:`path/to/template.html` admindocs :template:`path/to/template.html` वाक्यविन्यास, Django के टेम्पलेट लोडर के साथ उस टेम्पलेट के पथ को सत्यापित करेगा। यह जांचने का एक आसान तरीका हो सकता है कि क्या निर्दिष्ट टेम्पलेट मौजूद है और यह दिखाने के लिए कि टेम्पलेट कहाँ संग्रहीत है।

बुकमार्क शामिल हैं

एक बुकमार्क admindocs पृष्ठ से उपलब्ध है:

इस पृष्ठ के लिए प्रलेखन
उस पृष्ठ को उत्पन्न करने वाले दृश्य के लिए आपको किसी भी पृष्ठ से दस्तावेज़ीकरण में जोड़ देता है।

इस बुकमार्कलेट का उपयोग करने के लिए यह आवश्यक है कि XViewMiddleware स्थापित हो और जिसे आप Django admin में एक User रूप में is_staff True सेट पर सेट करें।