Документирование задач с помощью Sphinx¶

Usage¶

The Celery extension for Sphinx requires Sphinx 2.0 or later.

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)[исходный код]

Sphinx task directive.

get_signature_prefix(sig)[исходный код]

May return a prefix to put before the object name in the signature.

class celery.contrib.sphinx.TaskDocumenter(directive: DocumenterBridge, name: str, indent: str = '')[исходный код]

Document task definitions.

classmethod can_document_member(member, membername, isattr, parent)[исходный код]

Called to see if a member can be documented by this Documenter.

check_module()[исходный код]

Check if self.object is really defined in the module given by self.modname.

document_members(all_members=False)[исходный код]

Generate reST for member documentation.

If all_members is True, document all members, else those given by self.options.members.

format_args()[исходный код]

Format the argument signature of self.object.

Should return None if the object does not have a signature.

member_order = 11

order if autodoc_member_order is set to „groupwise“

objtype = 'task'

name by which the directive is called (auto…) and the default generated directive name

celery.contrib.sphinx.autodoc_skip_member_handler(app, what, name, obj, skip, options)[исходный код]

Handler for autodoc-skip-member event.

celery.contrib.sphinx.setup(app)[исходный код]

Setup Sphinx extension.