This document describes the current stable version of Celery (3.1). For development docs, go here.


Sphinx documentation plugin


Add the extension to your docs/ configuration module:

extensions = (...,

If you would like to change the prefix for tasks in reference documentation then you can change the celery_task_prefix configuration value:

celery_task_prefix = '(task)'  # < default

With the extension installed autodoc will automatically find task decorated objects and generate the correct (as well as add a (task) prefix), and you can also refer to the tasks using :task:proj.tasks.add syntax.

Use .. autotask:: to manually document a task.

Previous topic


Next topic


This Page