Gineadóir doiciméadaithe riaracháin DjangoLink to this heading#

ForbhreathnúLink to this heading#

Chun an: mod: ~django.contrib.admindocs a ghníomhachtú, beidh ort an méid seo a leanas a dhéanamh:

• Cuir: MOD: django.contrib.admindocs le do: socrú: INSTALLED_APPS.

• Cuir path ('admin/doc/', include ('django.contrib.admindocs.urls')) ``le do `urlpatterns. Déan cinnte go bhfuil an iontráil 'admin/' san áireamh aige roimh*, ionas nach láimhseálfar iarratais chuig /admin/doc/ ag an dara iontráil.

• Suiteáil an pacáiste: pypi: docutils 0.19+.

• **Roghnach: ** Ag baint úsáide as na marcanna leabhar admindocs teastaíonn Django.Contrib.adminDocs.Middleware.xviewMiddleware a shuiteáil.

Nuair a bheidh na céimeanna sin críochnaithe, is féidir leat tosú ag brabhsáil na doiciméadaithe trí dhul chuig do chomhéadan riaracháin agus cliceáil ar an nasc “Doiciméadú” ar dheis uachtarach an leathanaigh

Cúntóirí doiciméadaitheLink to this heading#

Is féidir an marcáil speisialta seo a leanas a úsáid i do docstrings chun hipearnasc a chruthú go héasca le comhpháirteanna eile:

Each of these support custom link text with the format :role:`link text <link>`. For example, :tag:`block <built_in-block>`.

Tagairt múnlaLink to this heading#

The models section of the admindocs page describes each model that the user has access to along with all the fields, properties, and methods available on it. Relationships to other models appear as hyperlinks. Descriptions are pulled from help_text attributes on fields or from docstrings on model methods.

D'fhéadfadh cuma seo a bheith ar mhúnla le cáipéisíocht úsáideach:

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."""
        ...

Féach tagairtLink to this heading#

Tá iontráil ar leithligh ag gach URL ar do shuíomh sa leathanach admindocs, agus cliceáil ar URL ar leith taispeánfar an radharc comhfhreagrach duit. I measc na rudaí cabhracha is féidir leat a dhoiciméadú i docstrings feidhm amharc tá:

• Cur síos gairid ar an méid a dhéanann an dearcadh.

• An comhthéacs, nó liosta d'athróg atá ar fáil i dteimpléad an amharc.

• Ainm an teimpléid nó na teimpléid a úsáidtear don radharc sin.

Mar shampla:

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)

Clibeanna teimpléad agus tagairt scagairLink to this heading#

<ref-templates-builtins-tags><ref-templates-builtins-filters>Déanann na hailt clibe agus scagairí admindocs cur síos ar na clibeanna agus na scagairí go léir a thagann le Django (i ndáiríre, tagann an doiciméadú: ref: tagairt clibeanna ionsuite `agus:ref: `tagairt scagaire ionsuite go díreach ó na leathanaigh sin). Taispeánfar aon chlibeanna nó scagairí a chruthaíonn tú nó a chuireann aip tríú páirtí leis sna codanna seo freisin.

Tagairt teimpléadLink to this heading#

<template-loaders>Cé nach gcuimsíonn admindocs áit chun teimpléid a dhoiciméadú leo féin, má úsáideann tú an :template: `path/to/template.html comhréir i docstring fíoróidh an leathanach mar thoradh air cosán an teimpléid sin le Django's:ref: luchtóirí teimpléadaithe. Is bealach áisiúil é seo chun a sheiceáil an bhfuil an teimpléad sonraithe ann agus chun a thaispeáint cá bhfuil an teimpléad sin stóráilte ar an gcóras comhaid.

Leabharmharcanna san áireamhLink to this heading#

Tá leabharmharclár amháin ar fáil ón leathanach admindocs:

Doiciméadúchán le hadhaigh an leathanach seo

Tógann se tusa ón aon leathanach go dtí an doiciméadúchán le hadhaigh an radharc a rinne an leathanach.

<django.contrib.admin>Ag baint úsáide as an leabharmharclár seo teastaíonn XViewMiddleWare suiteáilte agus go bhfuil tú logáilte isteach in:mod: Django admin `mar a:class: `~django.contrib.auth.models.is_staff socraithe go True.