{"title":"Gineadóir doiciméadaithe riaracháin Django","version":"6.0","locale":"ga","docname":"ref/contrib/admin/admindocs","url":"/ga/6.0/ref/contrib/admin/admindocs/","canonical":"https://djangodocs.dev/ga/6.0/ref/contrib/admin/admindocs/","summary":"Django's:mod: ~django.contrib.admindocs tarraingíonn aip cáipéisíocht ó na docstrings samhlacha, tuairimí, clibeanna teimpléad, agus scagairí…","html":"

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

\n

<django.contrib.admin>Django's:mod: ~django.contrib.admindocs tarraingíonn aip cáipéisíocht ó na docstrings samhlacha, tuairimí, clibeanna teimpléad, agus scagairí teimpléad d'aon aip in:setting: INSTALLED_APPS agus cuireann sé an doiciméad sin ar fáil ó:mod: `Django admin `.

\n
\n

ForbhreathnúLink to this heading#

\n

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

\n\n

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

\n
\n
\n

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

\n

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:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Comhpháirt Django

Róil athstruchtúrthéacs

Samhla

:model: `App_Label.ModelName`

Radharcanna

:view: `app_label.view_name

Clibeanna teimpléid

:tag: `tagname`

Ar ais go Doiciméadúchán

:filter: `ainm scagair `

Teimpléid

:template: `path/to/teimpléad.html`

\n
\n

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

\n\n
\n
\n

Tagairt múnlaLink to this heading#

\n

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

\n

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

\n
Code
class BlogEntry(models.Model):\n    """\n    Stores a single blog entry, related to :model:`blog.Blog` and\n    :model:`auth.User`.\n    """\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,\n        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        ...\n
\n\n
\n
\n

Féach tagairtLink to this heading#

\n

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á:

\n\n

Mar shampla:

\n
Code
from django.shortcuts import render\n\nfrom myapp.models import MyModel\n\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)\n
\n
\n
\n

Clibeanna teimpléad agus tagairt scagairLink to this heading#

\n

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

\n
\n
\n

Tagairt teimpléadLink to this heading#

\n

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

\n
\n
\n

Leabharmharcanna san áireamhLink to this heading#

\n

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

\n
\n
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.

\n
\n
\n

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

\n
","rootId":"module-django.contrib.admindocs","toc":[{"title":"Forbhreathnú","anchor":"overview","children":[]},{"title":"Cúntóirí doiciméadaithe","anchor":"documentation-helpers","children":[]},{"title":"Tagairt múnla","anchor":"model-reference","children":[]},{"title":"Féach tagairt","anchor":"view-reference","children":[]},{"title":"Clibeanna teimpléad agus tagairt scagair","anchor":"template-tags-and-filters-reference","children":[]},{"title":"Tagairt teimpléad","anchor":"template-reference","children":[]},{"title":"Leabharmharcanna san áireamh","anchor":"included-bookmarklets","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"Tagairt API","url":"/ga/6.0/ref/"},{"docname":"ref/contrib/index","title":"Pacáistí contrib","url":"/ga/6.0/ref/contrib/"},{"docname":"ref/contrib/admin/index","title":"Suíomh riaracháin Django","url":"/ga/6.0/ref/contrib/admin/"}],"prev":{"docname":"ref/contrib/admin/filters","title":"ModelAdmin Scagairí Liosta","url":"/ga/6.0/ref/contrib/admin/filters/"},"next":{"docname":"ref/contrib/admin/javascript","title":"Saincheaptha JavaScript sa riarachán","url":"/ga/6.0/ref/contrib/admin/javascript/"},"formats":{"html":"/ga/6.0/ref/contrib/admin/admindocs/","markdown":"/ga/6.0/ref/contrib/admin/admindocs.md","json":"/ga/6.0/ref/contrib/admin/admindocs.json"},"source":"https://github.com/django/django/blob/stable/6.0.x/docs/ref/contrib/admin/admindocs.txt","official":"https://docs.djangoproject.com/ga/6.0/ref/contrib/admin/admindocs/","inVersions":["6.1","6.0","5.2"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}