mirror of https://github.com/django/django.git
Add reST role to templates named in some view docs.
This makes the templates link up correctly in the admindocs.
This commit is contained in:
parent
fa182e8ae8
commit
24dec9edaa
|
@ -17,7 +17,7 @@ def flag(request, comment_id, next=None):
|
||||||
"""
|
"""
|
||||||
Flags a comment. Confirmation on GET, action on POST.
|
Flags a comment. Confirmation on GET, action on POST.
|
||||||
|
|
||||||
Templates: `comments/flag.html`,
|
Templates: :template:`comments/flag.html`,
|
||||||
Context:
|
Context:
|
||||||
comment
|
comment
|
||||||
the flagged `comments.comment` object
|
the flagged `comments.comment` object
|
||||||
|
@ -43,7 +43,7 @@ def delete(request, comment_id, next=None):
|
||||||
Deletes a comment. Confirmation on GET, action on POST. Requires the "can
|
Deletes a comment. Confirmation on GET, action on POST. Requires the "can
|
||||||
moderate comments" permission.
|
moderate comments" permission.
|
||||||
|
|
||||||
Templates: `comments/delete.html`,
|
Templates: :template:`comments/delete.html`,
|
||||||
Context:
|
Context:
|
||||||
comment
|
comment
|
||||||
the flagged `comments.comment` object
|
the flagged `comments.comment` object
|
||||||
|
@ -70,7 +70,7 @@ def approve(request, comment_id, next=None):
|
||||||
Approve a comment (that is, mark it as public and non-removed). Confirmation
|
Approve a comment (that is, mark it as public and non-removed). Confirmation
|
||||||
on GET, action on POST. Requires the "can moderate comments" permission.
|
on GET, action on POST. Requires the "can moderate comments" permission.
|
||||||
|
|
||||||
Templates: `comments/approve.html`,
|
Templates: :template:`comments/approve.html`,
|
||||||
Context:
|
Context:
|
||||||
comment
|
comment
|
||||||
the `comments.comment` object for approval
|
the `comments.comment` object for approval
|
||||||
|
|
|
@ -56,7 +56,7 @@ def confirmation_view(template, doc="Display a confirmation view."):
|
||||||
confirmed.__doc__ = textwrap.dedent("""\
|
confirmed.__doc__ = textwrap.dedent("""\
|
||||||
%s
|
%s
|
||||||
|
|
||||||
Templates: `%s``
|
Templates: :template:`%s``
|
||||||
Context:
|
Context:
|
||||||
comment
|
comment
|
||||||
The posted comment
|
The posted comment
|
||||||
|
|
|
@ -23,7 +23,7 @@ def flatpage(request, url):
|
||||||
|
|
||||||
Models: `flatpages.flatpages`
|
Models: `flatpages.flatpages`
|
||||||
Templates: Uses the template defined by the ``template_name`` field,
|
Templates: Uses the template defined by the ``template_name`` field,
|
||||||
or `flatpages/default.html` if template_name is not defined.
|
or :template:`flatpages/default.html` if template_name is not defined.
|
||||||
Context:
|
Context:
|
||||||
flatpage
|
flatpage
|
||||||
`flatpages.flatpages` object
|
`flatpages.flatpages` object
|
||||||
|
|
|
@ -12,7 +12,7 @@ def page_not_found(request, template_name='404.html'):
|
||||||
"""
|
"""
|
||||||
Default 404 handler.
|
Default 404 handler.
|
||||||
|
|
||||||
Templates: `404.html`
|
Templates: :template:`404.html`
|
||||||
Context:
|
Context:
|
||||||
request_path
|
request_path
|
||||||
The path of the requested URL (e.g., '/app/pages/bad_page/')
|
The path of the requested URL (e.g., '/app/pages/bad_page/')
|
||||||
|
@ -26,7 +26,7 @@ def server_error(request, template_name='500.html'):
|
||||||
"""
|
"""
|
||||||
500 error handler.
|
500 error handler.
|
||||||
|
|
||||||
Templates: `500.html`
|
Templates: :template:`500.html`
|
||||||
Context: None
|
Context: None
|
||||||
"""
|
"""
|
||||||
t = loader.get_template(template_name) # You need to create a 500.html template.
|
t = loader.get_template(template_name) # You need to create a 500.html template.
|
||||||
|
@ -41,7 +41,7 @@ def permission_denied(request, template_name='403.html'):
|
||||||
"""
|
"""
|
||||||
Permission denied (403) handler.
|
Permission denied (403) handler.
|
||||||
|
|
||||||
Templates: `403.html`
|
Templates: :template:`403.html`
|
||||||
Context: None
|
Context: None
|
||||||
|
|
||||||
If the template does not exist, an Http403 response containing the text
|
If the template does not exist, an Http403 response containing the text
|
||||||
|
|
Loading…
Reference in New Issue