From ffef9ce7035bc5341eecc2991613218751d6b9f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Bryon?= Date: Mon, 3 Mar 2014 07:58:43 +0100 Subject: [PATCH] Refs #80 - Referenced options inherited from DownloadMixin in each view's documentation. --- docs/views/http.txt | 10 ++++++++++ docs/views/object.txt | 10 ++++++++++ docs/views/path.txt | 10 ++++++++++ docs/views/storage.txt | 10 ++++++++++ docs/views/virtual.txt | 10 ++++++++++ 5 files changed, 50 insertions(+) diff --git a/docs/views/http.txt b/docs/views/http.txt index 4d334dc..7c785bf 100644 --- a/docs/views/http.txt +++ b/docs/views/http.txt @@ -26,6 +26,16 @@ Setup a view to stream files given URL: :language: python +************ +Base options +************ + +:class:`HTTPDownloadView` inherits from +:class:`~django_downloadview.views.base.DownloadMixin`, which has various +options such as :attr:`~django_downloadview.views.base.DownloadMixin.basename` +or :attr:`~django_downloadview.views.base.DownloadMixin.attachment`. + + ************* API reference ************* diff --git a/docs/views/object.txt b/docs/views/object.txt index 4cc3752..2ed45ce 100644 --- a/docs/views/object.txt +++ b/docs/views/object.txt @@ -41,6 +41,16 @@ Setup a view to stream the ``file`` attribute: :lines: 1-7, 8-10, 17 +************ +Base options +************ + +:class:`ObjectDownloadView` inherits from +:class:`~django_downloadview.views.base.DownloadMixin`, which has various +options such as :attr:`~django_downloadview.views.base.DownloadMixin.basename` +or :attr:`~django_downloadview.views.base.DownloadMixin.attachment`. + + *************************** Serving specific file field *************************** diff --git a/docs/views/path.txt b/docs/views/path.txt index f7d177f..13b336c 100644 --- a/docs/views/path.txt +++ b/docs/views/path.txt @@ -28,6 +28,16 @@ Setup a view to stream files given path: :emphasize-lines: 14 +************ +Base options +************ + +:class:`PathDownloadView` inherits from +:class:`~django_downloadview.views.base.DownloadMixin`, which has various +options such as :attr:`~django_downloadview.views.base.DownloadMixin.basename` +or :attr:`~django_downloadview.views.base.DownloadMixin.attachment`. + + ************************** Computing path dynamically ************************** diff --git a/docs/views/storage.txt b/docs/views/storage.txt index 9878d88..b5d2c81 100644 --- a/docs/views/storage.txt +++ b/docs/views/storage.txt @@ -34,6 +34,16 @@ via URLconfs: :lines: 1-7, 8-10, 14 +************ +Base options +************ + +:class:`StorageDownloadView` inherits from +:class:`~django_downloadview.views.base.DownloadMixin`, which has various +options such as :attr:`~django_downloadview.views.base.DownloadMixin.basename` +or :attr:`~django_downloadview.views.base.DownloadMixin.attachment`. + + ************************** Computing path dynamically ************************** diff --git a/docs/views/virtual.txt b/docs/views/virtual.txt index 706d6af..d7ea396 100644 --- a/docs/views/virtual.txt +++ b/docs/views/virtual.txt @@ -18,6 +18,16 @@ it returns a suitable file wrapper... exited. +************ +Base options +************ + +:class:`VirtualDownloadView` inherits from +:class:`~django_downloadview.views.base.DownloadMixin`, which has various +options such as :attr:`~django_downloadview.views.base.DownloadMixin.basename` +or :attr:`~django_downloadview.views.base.DownloadMixin.attachment`. + + *************************************** Serve text (string or unicode) or bytes ***************************************