Refs #80 - Referenced options inherited from DownloadMixin in each view's documentation.

This commit is contained in:
Benoît Bryon 2014-03-03 07:58:43 +01:00
parent 7875999fe2
commit ffef9ce703
5 changed files with 50 additions and 0 deletions

View file

@ -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
*************

View file

@ -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
***************************

View file

@ -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
**************************

View file

@ -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
**************************

View file

@ -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
***************************************