Skip to content

Commit

Permalink
More buildable options added to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
palewire committed Mar 20, 2016
1 parent c9f659a commit 9dd5242
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions docs/buildableviews.rst
Expand Up @@ -297,6 +297,22 @@ BuildableYearArchiveView
The URL at which the detail page should appear. By default it is /archive/ + the year in
the generic view's ``year_format`` attribute.

.. py:attribute:: build_method
An alias to the ``build_dated_queryset`` method used by the :doc:`management commands </managementcommands>`

.. py:method:: build_dated_queryset()
Writes the rendered HTML for all publishable dates to the build directory.

.. py:method:: build_year(obj)
Writes the rendered HTML for the provided year to the build directory.

.. py:method:: unbuild_year(obj)
Deletes the directory where the provided year's flat files are stored.

**Example myapp/views.py**

.. code-block:: python
Expand Down Expand Up @@ -347,6 +363,22 @@ BuildableMonthArchiveView
The URL at which the detail page should appear. By default it is /archive/ + the
year in self.year_format + the month in self.month_format. An example would be /archive/2016/01/.

.. py:attribute:: build_method
An alias to the ``build_dated_queryset`` method used by the :doc:`management commands </managementcommands>`

.. py:method:: build_dated_queryset()
Writes the rendered HTML for all publishable dates to the build directory.

.. py:method:: build_month(obj)
Writes the rendered HTML for the provided month to the build directory.

.. py:method:: unbuild_month(obj)
Deletes the directory where the provided month's flat files are stored.

**Example myapp/views.py**

.. code-block:: python
Expand Down Expand Up @@ -396,6 +428,22 @@ BuildableDayArchiveView
The URL at which the detail page should appear. By default it is /archive/ + the year in self.year_format + the
month in self.month_format + the day in the self.day_format. An example would be /archive/2016/01/01/.

.. py:attribute:: build_method
An alias to the ``build_dated_queryset`` method used by the :doc:`management commands </managementcommands>`

.. py:method:: build_dated_queryset()
Writes the rendered HTML for all publishable dates to the build directory.

.. py:method:: build_day(obj)
Writes the rendered HTML for the provided day to the build directory.

.. py:method:: unbuild_day(obj)
Deletes the directory where the provided day's flat files are stored.

**Example myapp/views.py**

.. code-block:: python
Expand Down

0 comments on commit 9dd5242

Please sign in to comment.