Browse Source

Fixed Sphinx build errors/warnings

Ask Solem 15 years ago
parent
commit
59681f5f5d

+ 0 - 1
celery/decorators.py

@@ -82,4 +82,3 @@ def periodic_task(**options):
 
     """
     return task(**dict({"base": PeriodicTask}, **options))
-

+ 5 - 7
celery/views.py

@@ -13,7 +13,7 @@ def task_view(task):
     """Decorator turning any task into a view that applies the task
     asynchronously.
 
-    :returns: a JSON dictionary containing the keys ``ok``, and
+    Returns a JSON dictionary containing the keys ``ok``, and
         ``task_id``.
 
     """
@@ -35,11 +35,8 @@ def task_view(task):
 def apply(request, task_name):
     """View applying a task.
 
-    Example:
-        http://e.com/celery/apply/task_name/arg1/arg2//?kwarg1=a&kwarg2=b
-
-    **NOTE** Use with caution, preferably not make this publicly accessible
-    without ensuring your code is safe!
+    **Note:** Please use this with caution. Preferably you shouldn't make this
+        publicly accessible without ensuring your code is safe!
 
     """
     try:
@@ -54,7 +51,6 @@ def is_task_successful(request, task_id):
     response_data = {"task": {"id": task_id,
                               "executed": AsyncResult(task_id).successful()}}
     return HttpResponse(JSON_dump(response_data), mimetype="application/json")
-is_task_done = is_task_successful # Backward compatible
 
 
 def task_status(request, task_id):
@@ -82,6 +78,8 @@ def task_webhook(fun):
 
     Example:
 
+    .. code-block:: python
+
         @task_webhook
         def add(request):
             x = int(request.GET["x"])

+ 2 - 1
contrib/release/doc4allmods

@@ -2,7 +2,8 @@
 
 PACKAGE="$1"
 SKIP_PACKAGES="$PACKAGE tests management urls"
-SKIP_FILES="celery.bin.rst celery.contrib.rst"
+SKIP_FILES="celery.bin.rst celery.task.rest.rst celery.contrib.rst
+            celery.contrib.batches.rst"
 
 modules=$(find "$PACKAGE" -name "*.py")
 

+ 1 - 0
docs/cookbook/index.rst

@@ -6,6 +6,7 @@
     :maxdepth: 2
 
     tasks
+    daemonizing
     unit-testing
 
 This page contains common recipes and techniques.

+ 2 - 0
docs/getting-started/first-steps-with-celery.rst

@@ -93,6 +93,8 @@ help command::
 For info on how to run celery as standalone daemon, see 
 :doc:`daemon mode reference<../cookbook/daemonizing>`
 
+.. _`supervisord`: http://supervisord.org
+
 Executing the task
 ==================
 

+ 2 - 4
docs/getting-started/first-steps-with-django.rst

@@ -27,11 +27,9 @@ That's it.
 
 There are more options available, like how many processes you want to
 work in parallel (the ``CELERY_CONCURRENCY`` setting). You can also
-configure the backend used for storing task statuses. For now though, 
+configure the backend used for storing task statuses. For now though,
 this should do. For all of the options available, please see the 
-:doc:`configuration directive
-
-reference<../configuration>`.
+:doc:`configuration directive reference<../configuration>`.
 
 **Note:** If you're using SQLite as the Django database back-end,
 ``celeryd`` will only be able to process one task at a time, this is

+ 1 - 1
pavement.py

@@ -51,7 +51,7 @@ def upload_docs(options):
 
 @task
 def autodoc(options):
-    sh("contrib/release/doc4allmods/celery")
+    sh("contrib/release/doc4allmods celery")
 
 
 @task