From 05fa0625494676f4b7c662bb2cf0ea8d19b0418c Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Sat, 4 Jul 2015 12:16:51 +0200 Subject: [PATCH] Almost ready for 0.2.0 --- docs/admin.rst | 32 +++++++++++++++++++++++++++++++- docs/tasks.rst | 2 +- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/docs/admin.rst b/docs/admin.rst index afee2126..1135ad58 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -3,4 +3,34 @@ Admin pages =========== -TODO \ No newline at end of file +Django Q does not use custom HTML pages, but instead uses what is offered by Django's model admin by default. +When you open Django Q's admin pages you will see three models: + +Successful tasks +---------------- + +Shows all successfully executed tasks. Meaning they did not encounter any errors during execution. +From here you can look at details of each task or delete them. + +Uses the :class:`Success` proxy model. + +.. tip:: + + The maximum number of succesful tasks can be set using the `save_limit` :ref:`configuration` option. + + + +Failed tasks +------------ +Failed tasks have encountered an error, preventing them from finishing execution. +The worker will try to put the error in the `result` field of the task so you can review what happened. + +You can resubmit a failed task back to the queue using the admins action menu. + +Uses the :class:`Failure` proxy model + +Scheduled tasks +--------------- + + +Uses the :class:`Schedule` model diff --git a/docs/tasks.rst b/docs/tasks.rst index 982609c6..54b7cf3f 100644 --- a/docs/tasks.rst +++ b/docs/tasks.rst @@ -1,7 +1,7 @@ Tasks ===== -Use :py:func:`async` from your code to quickly offload tasks to the py:module:`cluster`: +Use :py:func:`async` from your code to quickly offload tasks to the :mod:`cluster`: .. code:: python