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

celery.contrib.sphinx

Sphinx documentation plugin used to document tasks.

Introduction

Usage

Add the extension to your docs/conf.py configuration module:

extensions = (...,
              'celery.contrib.sphinx')

If you’d 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.

class celery.contrib.sphinx.TaskDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Sphinx task directive.

class celery.contrib.sphinx.TaskDocumenter(directive, name, indent=u'')[source]

Document task definitions.

celery.contrib.sphinx.setup(app)[source]

Setup Sphinx extension.