Lots of documentation improvements

celery/bin/celeryev.py

@@ -493,7 +493,7 @@ def eventdump():
         conn and conn.close()
 
 
-def run_celeryev(dump=False):
+def run_celeryev(dump=False, **kwargs):
     if dump:
         return eventdump()
     return eventtop()

celery/execute/__init__.py

@@ -19,54 +19,60 @@ def apply_async(task, args=None, kwargs=None, countdown=None, eta=None,
         **options):
     """Run a task asynchronously by the celery daemon(s).
 
-    :param task: The task to run (a callable object, or a :class:`Task`
-        instance
+    :param task: The :class:`~celery.task.base.Task` to run.
 
     :keyword args: The positional arguments to pass on to the
-        task (a ``list``).
+      task (a :class:`list` or :class:`tuple`).
 
-    :keyword kwargs: The keyword arguments to pass on to the task (a ``dict``)
+    :keyword kwargs: The keyword arguments to pass on to the
+      task (a :class:`dict`)
 
     :keyword countdown: Number of seconds into the future that the task should
-        execute. Defaults to immediate delivery (Do not confuse that with
-        the ``immediate`` setting, they are unrelated).
+      execute. Defaults to immediate delivery (Do not confuse that with
+      the ``immediate`` setting, they are unrelated).
 
-    :keyword eta: A :class:`datetime.datetime` object that describes the
-        absolute time when the task should execute. May not be specified
-        if ``countdown`` is also supplied. (Do not confuse this with the
-        ``immediate`` setting, they are unrelated).
+    :keyword eta: A :class:`~datetime.datetime` object that describes the
+      absolute time when the task should execute. May not be specified
+      if ``countdown`` is also supplied. (Do not confuse this with the
+      ``immediate`` setting, they are unrelated).
+
+    :keyword connection: Re-use existing broker connection instead
+      of establishing a new one. The ``connect_timeout`` argument is
+      not respected if this is set.
+
+    :keyword connect_timeout: The timeout in seconds, before we give up
+      on establishing a connection to the AMQP server.
 
     :keyword routing_key: The routing key used to route the task to a worker
-        server.
+      server. Defaults to the tasks :attr:`~celery.task.base.Task.exchange`
+      attribute.
 
     :keyword exchange: The named exchange to send the task to. Defaults to
-        :attr:`celery.task.base.Task.exchange`.
+      the tasks :attr:`~celery.task.base.Task.exchange` attribute.
 
     :keyword exchange_type: The exchange type to initalize the exchange as
-        if not already declared.
-        Defaults to :attr:`celery.task.base.Task.exchange_type`.
+      if not already declared. Defaults to the tasks
+      :attr:`~celery.task.base.Task.exchange_type` attribute.
 
     :keyword immediate: Request immediate delivery. Will raise an exception
-        if the task cannot be routed to a worker immediately.
-        (Do not confuse this parameter with the ``countdown`` and ``eta``
-        settings, as they are unrelated).
+      if the task cannot be routed to a worker immediately.
+      (Do not confuse this parameter with the ``countdown`` and ``eta``
+      settings, as they are unrelated). Defaults to the tasks
+      :attr:`~celery.task.base.Task.immediate` attribute.
 
     :keyword mandatory: Mandatory routing. Raises an exception if there's
-        no running workers able to take on this task.
-
-    :keyword connection: Re-use existing AMQP connection.
-        The ``connect_timeout`` argument is not respected if this is set.
-
-    :keyword connect_timeout: The timeout in seconds, before we give up
-        on establishing a connection to the AMQP server.
+      no running workers able to take on this task. Defaults to the tasks
+      :attr:`~celery.task.base.Task.mandatory` attribute.
 
     :keyword priority: The task priority, a number between ``0`` and ``9``.
+      Defaults to the tasks :attr:`~celery.task.base.Task.priority` attribute.
 
     :keyword serializer: A string identifying the default serialization
-        method to use. Defaults to the ``CELERY_TASK_SERIALIZER`` setting.
-        Can be ``pickle`` ``json``, ``yaml``, or any custom serialization
-        methods that have been registered with
-        :mod:`carrot.serialization.registry`.
+      method to use. Defaults to the ``CELERY_TASK_SERIALIZER`` setting.
+      Can be ``pickle`` ``json``, ``yaml``, or any custom serialization
+      methods that have been registered with
+      :mod:`carrot.serialization.registry`. Defaults to the tasks
+      :attr:`~celery.task.base.Task.serializer` attribute.
 
     **Note**: If the ``CELERY_ALWAYS_EAGER`` setting is set, it will be
     replaced by a local :func:`apply` call instead.
@@ -95,7 +101,16 @@ def apply_async(task, args=None, kwargs=None, countdown=None, eta=None,
 def send_task(name, args=None, kwargs=None, countdown=None, eta=None,
         task_id=None, publisher=None, connection=None, connect_timeout=None,
         result_cls=AsyncResult, **options):
+    """Send task by name.
+
+    Useful if you don't have access to the :class:`~celery.task.base.Task`
+    class.
+
+    :param name: Name of task to execute.
 
+    Supports the same arguments as :func:`apply_async`.
+
+    """
     exchange = options.get("exchange")
     exchange_type = options.get("exchange_type")
 

celery/result.py

@@ -173,16 +173,15 @@ class AsyncResult(BaseAsyncResult):
 
 
 class TaskSetResult(object):
-    """Working with :class:`celery.task.TaskSet` results.
+    """Working with :class:`~celery.task.TaskSet` results.
 
     An instance of this class is returned by
-    :meth:`celery.task.TaskSet.apply_async()`. It lets you inspect the
-    status and return values of the taskset as a single entity.
+    ``TaskSet``'s :meth:`~celery.task.TaskSet.apply_async()`. It enables
+    inspection of the subtasks status and return values as a single entity.
 
     :option taskset_id: see :attr:`taskset_id`.
     :option subtasks: see :attr:`subtasks`.
 
-
     .. attribute:: taskset_id
 
         The UUID of the taskset itself.
@@ -344,7 +343,7 @@ class TaskSetResult(object):
 
     @property
     def total(self):
-        """The total number of tasks in the :class:`celery.task.TaskSet`."""
+        """The total number of tasks in the :class:`~celery.task.TaskSet`."""
         return len(self.subtasks)
 
 

celery/task/base.py

@@ -67,9 +67,11 @@ class Task(object):
     :meth:`run` method.
 
     .. attribute:: name
+
         Name of the task.
 
     .. attribute:: abstract
+
         If ``True`` the task is an abstract base class.
 
     .. attribute:: type
@@ -147,6 +149,7 @@ class Task(object):
         The result store backend used for this task.
 
     .. attribute:: autoregister
+
         If ``True`` the task is automatically registered in the task
         registry, which is the default behaviour.
 
@@ -325,15 +328,15 @@ class Task(object):
         :param args: Positional arguments to retry with.
         :param kwargs: Keyword arguments to retry with.
         :keyword exc: Optional exception to raise instead of
-            :exc:`MaxRestartsExceededError` when the max restart limit has
-            been exceeded.
+            :exc:`~celery.exceptions.MaxRetriesExceededError` when the max
+            restart limit has been exceeded.
         :keyword countdown: Time in seconds to delay the retry for.
         :keyword eta: Explicit time and date to run the retry at (must be a
             :class:`datetime.datetime` instance).
         :keyword \*\*options: Any extra options to pass on to
             meth:`apply_async`. See :func:`celery.execute.apply_async`.
         :keyword throw: If this is ``False``, do not raise the
-            :exc:`celery.exceptions.RetryTaskError` exception,
+            :exc:`~celery.exceptions.RetryTaskError` exception,
             that tells the worker to mark the task as being retried.
             Note that this means the task will be marked as failed
             if the task raises an exception, or successful if it
@@ -420,7 +423,7 @@ class Task(object):
         :param args: Original arguments for the retried task.
         :param kwargs: Original keyword arguments for the retried task.
 
-        :keyword einfo: :class:`celery.datastructures.ExceptionInfo` instance,
+        :keyword einfo: :class:`~celery.datastructures.ExceptionInfo` instance,
            containing the traceback.
 
         The return value of this handler is ignored.
@@ -437,7 +440,7 @@ class Task(object):
         :param args: Original arguments for the task that failed.
         :param kwargs: Original keyword arguments for the task that failed.
 
-        :keyword einfo: :class:`celery.datastructures.ExceptionInfo` instance,
+        :keyword einfo: :class:`~celery.datastructures.ExceptionInfo` instance,
            containing the traceback (if any).
 
         The return value of this handler is ignored.
@@ -455,7 +458,7 @@ class Task(object):
         :param args: Original arguments for the task that failed.
         :param kwargs: Original keyword arguments for the task that failed.
 
-        :keyword einfo: :class:`celery.datastructures.ExceptionInfo` instance,
+        :keyword einfo: :class:`~celery.datastructures.ExceptionInfo` instance,
            containing the traceback.
 
         The return value of this handler is ignored.
@@ -506,8 +509,9 @@ class PeriodicTask(Task):
     .. attribute:: run_every
 
         *REQUIRED* Defines how often the task is run (its interval),
-        it can be a :class:`datetime.timedelta` object, a :class:`crontab`
-        object or an integer specifying the time in seconds.
+        it can be a :class:`~datetime.timedelta` object, a
+        :class:`~celery.task.schedules.crontab` object or an integer
+        specifying the time in seconds.
 
     .. attribute:: relative
 
@@ -578,7 +582,7 @@ class PeriodicTask(Task):
         super(PeriodicTask, self).__init__()
 
     def timedelta_seconds(self, delta):
-        """Convert :class:`datetime.timedelta` to seconds.
+        """Convert :class:`~datetime.timedelta` to seconds.
 
         Doesn't account for negative timedeltas.
 

docs/internals/reference/celery.backends.amqp.rst

@@ -6,3 +6,4 @@ Backend: AMQP - celery.backends.amqp
 
 .. automodule:: celery.backends.amqp
     :members:
+    :undoc-members:

docs/internals/reference/celery.backends.base.rst

@@ -6,5 +6,6 @@ Backend: Base - celery.backends.base
 
 .. automodule:: celery.backends.base
     :members:
+    :undoc-members:
 
 

docs/internals/reference/celery.backends.database.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.backends.database
     :members:
+    :undoc-members:

docs/internals/reference/celery.backends.mongodb.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.backends.mongodb
     :members:
+    :undoc-members:

docs/internals/reference/celery.backends.pyredis.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.backends.pyredis
     :members:
+    :undoc-members:

docs/internals/reference/celery.backends.rst

@@ -6,3 +6,4 @@ Backends - celery.backends
 
 .. automodule:: celery.backends
     :members:
+    :undoc-members:

docs/internals/reference/celery.backends.tyrant.rst

@@ -6,3 +6,4 @@ Backend: Tokyo Tyrant - celery.backends.tyrant
 
 .. automodule:: celery.backends.tyrant
     :members:
+    :undoc-members:

docs/internals/reference/celery.beat.rst

@@ -6,3 +6,4 @@ Clock Service - celery.beat
 
 .. automodule:: celery.beat
     :members:
+    :undoc-members:

docs/internals/reference/celery.concurrency.processes.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.concurrency.processes
     :members:
+    :undoc-members:

docs/internals/reference/celery.concurrency.threads.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.concurrency.threads
     :members:
+    :undoc-members:

docs/internals/reference/celery.datastructures.rst

@@ -6,3 +6,4 @@ Datastructures - celery.datastructures
 
 .. automodule:: celery.datastructures
     :members:
+    :undoc-members:

docs/internals/reference/celery.db.models.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.db.models
     :members:
+    :undoc-members:

docs/internals/reference/celery.db.session.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.db.session
     :members:
+    :undoc-members:

docs/internals/reference/celery.execute.trace.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.execute.trace
     :members:
+    :undoc-members:

docs/internals/reference/celery.log.rst

@@ -6,3 +6,4 @@ Logging - celery.log
 
 .. automodule:: celery.log
     :members:
+    :undoc-members:

docs/internals/reference/celery.platform.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.platform
     :members:
+    :undoc-members:

docs/internals/reference/celery.routes.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.routes
     :members:
+    :undoc-members:

docs/internals/reference/celery.serialization.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.serialization
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.compat.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.compat
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.dispatch.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.dispatch
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.dispatch.saferef.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.dispatch.saferef
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.dispatch.signal.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.dispatch.signal
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.functional.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.functional
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.info.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.info
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.mail.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.mail
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.patch.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.patch
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils
     :members:
+    :undoc-members:

docs/internals/reference/celery.utils.timeutils.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.utils.timeutils
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.buckets.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.buckets
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.control.builtins.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.control.builtins
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.control.registry.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.control.registry
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.control.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.control
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.controllers.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.controllers
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.heartbeat.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.heartbeat
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.job.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.job
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.listener.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.listener
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.pool.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.pool
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.rst

@@ -6,3 +6,4 @@ Multiprocessing Worker - celery.worker
 
 .. automodule:: celery.worker
     :members:
+    :undoc-members:

docs/internals/reference/celery.worker.scheduler.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.worker.scheduler
     :members:
+    :undoc-members:

docs/reference/celery.bin.camqadm.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.bin.camqadm
     :members:
+    :undoc-members:

docs/reference/celery.bin.celerybeat.rst

@@ -6,3 +6,4 @@ Celery Periodic Task Server - celery.bin.celerybeat
 
 .. automodule:: celery.bin.celerybeat
     :members:
+    :undoc-members:

docs/reference/celery.bin.celeryd.rst

@@ -6,3 +6,4 @@ Celery Worker Daemon - celery.bin.celeryd
 
 .. automodule:: celery.bin.celeryd
     :members:
+    :undoc-members:

docs/reference/celery.bin.celeryd_multi.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.bin.celeryd_multi
     :members:
+    :undoc-members:

docs/reference/celery.bin.celeryev.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.bin.celeryev
     :members:
+    :undoc-members:

docs/reference/celery.contrib.abortable.rst

@@ -6,3 +6,4 @@
 
  .. automodule:: celery.contrib.abortable
      :members:
+     :undoc-members:

docs/reference/celery.decorators.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.decorators
     :members:
+    :undoc-members:

docs/reference/celery.events.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.events
     :members:
+    :undoc-members:

docs/reference/celery.events.state.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.events.state
     :members:
+    :undoc-members:

docs/reference/celery.exceptions.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.exceptions
     :members:
+    :undoc-members:

docs/reference/celery.execute.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.execute
     :members:
+    :undoc-members:

docs/reference/celery.loaders.base.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.loaders.base
     :members:
+    :undoc-members:

docs/reference/celery.loaders.default.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.loaders.default
     :members:
+    :undoc-members:

docs/reference/celery.loaders.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.loaders
     :members:
+    :undoc-members:

docs/reference/celery.messaging.rst

@@ -6,3 +6,4 @@ Messaging - celery.messaging
 
 .. automodule:: celery.messaging
     :members:
+    :undoc-members:

docs/reference/celery.registry.rst

@@ -6,3 +6,4 @@ Task Registry - celery.registry
 
 .. automodule:: celery.registry
     :members:
+    :undoc-members:

docs/reference/celery.result.rst

@@ -6,3 +6,4 @@ Task Result - celery.result
 
 .. automodule:: celery.result
     :members:
+    :undoc-members:

docs/reference/celery.states.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.states
     :members:
+    :undoc-members:

docs/reference/celery.task.base.rst

@@ -5,4 +5,4 @@
 .. currentmodule:: celery.task.base
 
 .. automodule:: celery.task.base
-    :members:
+    :members: Task, PeriodicTask, TaskType

docs/reference/celery.task.builtins.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.task.builtins
     :members:
+    :undoc-members:

docs/reference/celery.task.control.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.task.control
     :members:
+    :undoc-members:

docs/reference/celery.task.http.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.task.http
     :members:
+    :undoc-members:

docs/reference/celery.task.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.task
     :members:
+    :undoc-members:

docs/reference/celery.task.schedules.rst

@@ -6,3 +6,4 @@
 
 .. automodule:: celery.task.schedules
     :members:
+    :undoc-members: