This document describes the current stable version of Celery (4.3). For development docs, go here.
Documenting Tasks with Sphinx¶
This document describes how auto-generate documentation for Tasks using Sphinx.
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 (e.g. when using the automodule directive)
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 alternatively 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.
-
get_signature_prefix
(sig)[source] May return a prefix to put before the object name in the signature.
-
-
class
celery.contrib.sphinx.
TaskDocumenter
(directive, name, indent=u'')[source] Document task definitions.
-
classmethod
can_document_member
(member, membername, isattr, parent)[source] Called to see if a member can be documented by this documenter.
-
check_module
()[source] Check if self.object is really defined in the module given by self.modname.
-
document_members
(all_members=False)[source] Generate reST for member documentation.
If all_members is True, do all members, else those given by self.options.members.
-
format_args
()[source] Format the argument signature of self.object.
Should return None if the object does not have a signature.
-
classmethod
-
celery.contrib.sphinx.
autodoc_skip_member_handler
(app, what, name, obj, skip, options)[source] Handler for autodoc-skip-member event.
-
celery.contrib.sphinx.
setup
(app)[source] Setup Sphinx extension.