summaryrefslogtreecommitdiff
path: root/docs/ref/class-based-views
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-02-01 11:54:26 -0500
committerTim Graham <timograham@gmail.com>2016-02-01 11:54:26 -0500
commita9fbf0735a213109ef4b02e02ff3e458b6a25929 (patch)
treec9ac521f09711d087e1c501b8427bb102d268fed /docs/ref/class-based-views
parentd7a6086825d4a308955e792f65fdd9b5f714a505 (diff)
[1.9.x] Fixed #26124 -- Added missing code formatting to docs headers.
Backport of a6ef025dfb2a1d1bd23893408eef6d066fb506d9 from master
Diffstat (limited to 'docs/ref/class-based-views')
-rw-r--r--docs/ref/class-based-views/base.txt12
-rw-r--r--docs/ref/class-based-views/flattened-index.txt80
-rw-r--r--docs/ref/class-based-views/generic-date-based.txt28
-rw-r--r--docs/ref/class-based-views/generic-display.txt8
-rw-r--r--docs/ref/class-based-views/generic-editing.txt16
-rw-r--r--docs/ref/class-based-views/mixins-date-based.txt24
-rw-r--r--docs/ref/class-based-views/mixins-editing.txt16
-rw-r--r--docs/ref/class-based-views/mixins-multiple-object.txt8
-rw-r--r--docs/ref/class-based-views/mixins-simple.txt8
-rw-r--r--docs/ref/class-based-views/mixins-single-object.txt8
10 files changed, 112 insertions, 96 deletions
diff --git a/docs/ref/class-based-views/base.txt b/docs/ref/class-based-views/base.txt
index ed2cd690ba..542d863db0 100644
--- a/docs/ref/class-based-views/base.txt
+++ b/docs/ref/class-based-views/base.txt
@@ -13,8 +13,8 @@ views or various mixins. Because this inheritance chain is very important, the
ancestor classes are documented under the section title of **Ancestors (MRO)**.
MRO is an acronym for Method Resolution Order.
-View
-====
+``View``
+========
.. class:: django.views.generic.base.View
@@ -97,8 +97,8 @@ View
Handles responding to requests for the OPTIONS HTTP verb. Returns a
list of the allowed HTTP method names for the view.
-TemplateView
-============
+``TemplateView``
+================
.. class:: django.views.generic.base.TemplateView
@@ -149,8 +149,8 @@ TemplateView
* Populated (through :class:`~django.views.generic.base.ContextMixin`) with
the keyword arguments captured from the URL pattern that served the view.
-RedirectView
-============
+``RedirectView``
+================
.. class:: django.views.generic.base.RedirectView
diff --git a/docs/ref/class-based-views/flattened-index.txt b/docs/ref/class-based-views/flattened-index.txt
index d549cd4245..2abe0eae30 100644
--- a/docs/ref/class-based-views/flattened-index.txt
+++ b/docs/ref/class-based-views/flattened-index.txt
@@ -11,8 +11,9 @@ documentation organized by the class which defines the behavior, see
Simple generic views
====================
-View
-----
+``View``
+--------
+
.. class:: View()
**Attributes** (with optional accessor):
@@ -26,8 +27,9 @@ View
* ``head()``
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
-TemplateView
-------------
+``TemplateView``
+----------------
+
.. class:: TemplateView()
**Attributes** (with optional accessor):
@@ -48,8 +50,9 @@ TemplateView
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-RedirectView
-------------
+``RedirectView``
+----------------
+
.. class:: RedirectView()
**Attributes** (with optional accessor):
@@ -75,8 +78,9 @@ RedirectView
Detail Views
============
-DetailView
-----------
+``DetailView``
+--------------
+
.. class:: DetailView()
**Attributes** (with optional accessor):
@@ -109,8 +113,9 @@ DetailView
List Views
==========
-ListView
---------
+``ListView``
+------------
+
.. class:: ListView()
**Attributes** (with optional accessor):
@@ -145,8 +150,9 @@ ListView
Editing views
=============
-FormView
---------
+``FormView``
+------------
+
.. class:: FormView()
**Attributes** (with optional accessor):
@@ -175,8 +181,9 @@ FormView
* :meth:`~django.views.generic.edit.ProcessFormView.post`
* :meth:`~django.views.generic.edit.ProcessFormView.put`
-CreateView
-----------
+``CreateView``
+--------------
+
.. class:: CreateView()
**Attributes** (with optional accessor):
@@ -217,8 +224,9 @@ CreateView
* ``put()``
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-UpdateView
-----------
+``UpdateView``
+--------------
+
.. class:: UpdateView()
**Attributes** (with optional accessor):
@@ -259,8 +267,9 @@ UpdateView
* ``put()``
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-DeleteView
-----------
+``DeleteView``
+--------------
+
.. class:: DeleteView()
**Attributes** (with optional accessor):
@@ -296,8 +305,9 @@ DeleteView
Date-based views
================
-ArchiveIndexView
-----------------
+``ArchiveIndexView``
+--------------------
+
.. class:: ArchiveIndexView()
**Attributes** (with optional accessor):
@@ -334,8 +344,9 @@ ArchiveIndexView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-YearArchiveView
----------------
+``YearArchiveView``
+-------------------
+
.. class:: YearArchiveView()
**Attributes** (with optional accessor):
@@ -375,8 +386,9 @@ YearArchiveView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-MonthArchiveView
-----------------
+``MonthArchiveView``
+--------------------
+
.. class:: MonthArchiveView()
**Attributes** (with optional accessor):
@@ -419,8 +431,9 @@ MonthArchiveView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-WeekArchiveView
----------------
+``WeekArchiveView``
+-------------------
+
.. class:: WeekArchiveView()
**Attributes** (with optional accessor):
@@ -461,8 +474,9 @@ WeekArchiveView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-DayArchiveView
---------------
+``DayArchiveView``
+------------------
+
.. class:: DayArchiveView()
**Attributes** (with optional accessor):
@@ -509,8 +523,9 @@ DayArchiveView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-TodayArchiveView
-----------------
+``TodayArchiveView``
+--------------------
+
.. class:: TodayArchiveView()
**Attributes** (with optional accessor):
@@ -557,8 +572,9 @@ TodayArchiveView
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
-DateDetailView
---------------
+``DateDetailView``
+------------------
+
.. class:: DateDetailView()
**Attributes** (with optional accessor):
diff --git a/docs/ref/class-based-views/generic-date-based.txt b/docs/ref/class-based-views/generic-date-based.txt
index 696c64ca9e..d2d7b153fc 100644
--- a/docs/ref/class-based-views/generic-date-based.txt
+++ b/docs/ref/class-based-views/generic-date-based.txt
@@ -22,8 +22,8 @@ views for displaying drilldown pages for date-based data.
def get_absolute_url(self):
return reverse('article-detail', kwargs={'pk': self.pk})
-ArchiveIndexView
-================
+``ArchiveIndexView``
+====================
.. class:: ArchiveIndexView
@@ -86,8 +86,8 @@ ArchiveIndexView
This will output all articles.
-YearArchiveView
-===============
+``YearArchiveView``
+===================
.. class:: YearArchiveView
@@ -191,8 +191,8 @@ YearArchiveView
{% endfor %}
</div>
-MonthArchiveView
-================
+``MonthArchiveView``
+====================
.. class:: MonthArchiveView
@@ -288,8 +288,8 @@ MonthArchiveView
{% endif %}
</p>
-WeekArchiveView
-===============
+``WeekArchiveView``
+===================
.. class:: WeekArchiveView
@@ -391,8 +391,8 @@ WeekArchiveView
output format that supports the US based week system. The :tfilter:`date`
filter ``'%U'`` outputs the number of seconds since the Unix epoch.
-DayArchiveView
-==============
+``DayArchiveView``
+==================
.. class:: DayArchiveView
@@ -493,8 +493,8 @@ DayArchiveView
{% endif %}
</p>
-TodayArchiveView
-================
+``TodayArchiveView``
+====================
.. class:: TodayArchiveView
@@ -550,8 +550,8 @@ TodayArchiveView
a different template, set the ``template_name`` attribute to be the
name of the new template.
-DateDetailView
-==============
+``DateDetailView``
+==================
.. class:: DateDetailView
diff --git a/docs/ref/class-based-views/generic-display.txt b/docs/ref/class-based-views/generic-display.txt
index 8f45ce654b..b97d3674cd 100644
--- a/docs/ref/class-based-views/generic-display.txt
+++ b/docs/ref/class-based-views/generic-display.txt
@@ -5,8 +5,8 @@ Generic display views
The two following generic class-based views are designed to display data. On
many projects they are typically the most commonly used views.
-DetailView
-==========
+``DetailView``
+==============
.. class:: django.views.generic.detail.DetailView
@@ -72,8 +72,8 @@ DetailView
<p>Published: {{ object.pub_date|date }}</p>
<p>Date: {{ now|date }}</p>
-ListView
-========
+``ListView``
+============
.. class:: django.views.generic.list.ListView
diff --git a/docs/ref/class-based-views/generic-editing.txt b/docs/ref/class-based-views/generic-editing.txt
index c861232e5a..3def731ee7 100644
--- a/docs/ref/class-based-views/generic-editing.txt
+++ b/docs/ref/class-based-views/generic-editing.txt
@@ -24,8 +24,8 @@ editing content:
def get_absolute_url(self):
return reverse('author-detail', kwargs={'pk': self.pk})
-FormView
-========
+``FormView``
+============
.. class:: django.views.generic.edit.FormView
@@ -80,8 +80,8 @@ FormView
</form>
-CreateView
-==========
+``CreateView``
+==============
.. class:: django.views.generic.edit.CreateView
@@ -135,8 +135,8 @@ CreateView
<input type="submit" value="Create" />
</form>
-UpdateView
-==========
+``UpdateView``
+==============
.. class:: django.views.generic.edit.UpdateView
@@ -192,8 +192,8 @@ UpdateView
<input type="submit" value="Update" />
</form>
-DeleteView
-==========
+``DeleteView``
+==============
.. class:: django.views.generic.edit.DeleteView
diff --git a/docs/ref/class-based-views/mixins-date-based.txt b/docs/ref/class-based-views/mixins-date-based.txt
index 921d3dee0d..31697226f9 100644
--- a/docs/ref/class-based-views/mixins-date-based.txt
+++ b/docs/ref/class-based-views/mixins-date-based.txt
@@ -10,8 +10,8 @@ Date-based mixins
:func:`~time.strftime` format characters. Do not try to use the format
characters from the :ttag:`now` template tag as they are not compatible.
-YearMixin
-=========
+``YearMixin``
+=============
.. class:: YearMixin
@@ -62,8 +62,8 @@ YearMixin
:attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`.
-MonthMixin
-==========
+``MonthMixin``
+==============
.. class:: MonthMixin
@@ -114,8 +114,8 @@ MonthMixin
:attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`.
-DayMixin
-========
+``DayMixin``
+============
.. class:: DayMixin
@@ -166,8 +166,8 @@ DayMixin
:attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`.
-WeekMixin
-=========
+``WeekMixin``
+=============
.. class:: WeekMixin
@@ -219,8 +219,8 @@ WeekMixin
:attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`.
-DateMixin
-=========
+``DateMixin``
+=============
.. class:: DateMixin
@@ -265,8 +265,8 @@ DateMixin
is greater than the current date/time. Returns
:attr:`~DateMixin.allow_future` by default.
-BaseDateListView
-================
+``BaseDateListView``
+====================
.. class:: BaseDateListView
diff --git a/docs/ref/class-based-views/mixins-editing.txt b/docs/ref/class-based-views/mixins-editing.txt
index a0cdaf311f..9cb86d882d 100644
--- a/docs/ref/class-based-views/mixins-editing.txt
+++ b/docs/ref/class-based-views/mixins-editing.txt
@@ -14,8 +14,8 @@ The following mixins are used to construct Django's editing views:
Examples of how these are combined into editing views can be found at
the documentation on :doc:`/ref/class-based-views/generic-editing`.
-FormMixin
-=========
+``FormMixin``
+=============
.. class:: django.views.generic.edit.FormMixin
@@ -98,8 +98,8 @@ FormMixin
Calls :meth:`get_form` and adds the result to the context data with the
name 'form'.
-ModelFormMixin
-==============
+``ModelFormMixin``
+==================
.. class:: django.views.generic.edit.ModelFormMixin
@@ -200,8 +200,8 @@ ModelFormMixin
Renders a response, providing the invalid form as context.
-ProcessFormView
-===============
+``ProcessFormView``
+===================
.. class:: django.views.generic.edit.ProcessFormView
@@ -240,8 +240,8 @@ ProcessFormView
through to :meth:`post`.
-DeletionMixin
-=============
+``DeletionMixin``
+=================
.. class:: django.views.generic.edit.DeletionMixin
diff --git a/docs/ref/class-based-views/mixins-multiple-object.txt b/docs/ref/class-based-views/mixins-multiple-object.txt
index 29680abb60..5328c989fb 100644
--- a/docs/ref/class-based-views/mixins-multiple-object.txt
+++ b/docs/ref/class-based-views/mixins-multiple-object.txt
@@ -2,8 +2,8 @@
Multiple object mixins
======================
-MultipleObjectMixin
-===================
+``MultipleObjectMixin``
+=======================
.. class:: django.views.generic.list.MultipleObjectMixin
@@ -196,8 +196,8 @@ MultipleObjectMixin
this context variable will be ``None``.
-MultipleObjectTemplateResponseMixin
-===================================
+``MultipleObjectTemplateResponseMixin``
+=======================================
.. class:: django.views.generic.list.MultipleObjectTemplateResponseMixin
diff --git a/docs/ref/class-based-views/mixins-simple.txt b/docs/ref/class-based-views/mixins-simple.txt
index 39e49bdace..6130b824a6 100644
--- a/docs/ref/class-based-views/mixins-simple.txt
+++ b/docs/ref/class-based-views/mixins-simple.txt
@@ -2,8 +2,8 @@
Simple mixins
=============
-ContextMixin
-============
+``ContextMixin``
+================
.. class:: django.views.generic.base.ContextMixin
@@ -31,8 +31,8 @@ ContextMixin
the documentation on :ref:`rendering a template context
<alters-data-description>`.
-TemplateResponseMixin
-=====================
+``TemplateResponseMixin``
+=========================
.. class:: django.views.generic.base.TemplateResponseMixin
diff --git a/docs/ref/class-based-views/mixins-single-object.txt b/docs/ref/class-based-views/mixins-single-object.txt
index e23664488b..911ac6f843 100644
--- a/docs/ref/class-based-views/mixins-single-object.txt
+++ b/docs/ref/class-based-views/mixins-single-object.txt
@@ -2,8 +2,8 @@
Single object mixins
====================
-SingleObjectMixin
-=================
+``SingleObjectMixin``
+=====================
.. class:: django.views.generic.detail.SingleObjectMixin
@@ -135,8 +135,8 @@ SingleObjectMixin
default this simply returns the value of :attr:`slug_field`.
-SingleObjectTemplateResponseMixin
-=================================
+``SingleObjectTemplateResponseMixin``
+=====================================
.. class:: django.views.generic.detail.SingleObjectTemplateResponseMixin