celery.contrib.sphinx

Плагин документации Sphinx, используемый для документирования задач.

Введение

Использование

Расширение Celery для Sphinx требует Sphinx версии 2.0 или более поздней.

Добавьте расширение в модуль конфигурации docs/conf.py:

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

Если вы хотите изменить префикс задач в справочной документации, измените значение конфигурации celery_task_prefix:

celery_task_prefix = '(task)'  # < default

После установки расширения autodoc будет автоматически находить объекты, декорированные как задачи (например, при использовании директивы automodule), и генерировать корректную документацию (а также добавлять префикс (task)). Кроме того, вы сможете ссылаться на задачи с помощью синтаксиса :task:proj.tasks.add.

Чтобы вручную документировать задачу, используйте .. autotask::.

Совместимость с Sphinx 9.0 и более поздними версиями

В Sphinx 9.0 была представлена переработанная реализация autodoc. Для корректной работы расширению Celery требуется устаревший режим autodoc на основе классов. При использовании Sphinx 9.0 или более поздней версии добавьте следующее в conf.py:

autodoc_use_legacy_class_based = True

Если этот параметр не задан, расширение включит его автоматически, однако рекомендуется задать его явно, чтобы избежать предупреждений.

classcelery.contrib.sphinx.TaskDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Директива задач Sphinx.

get_signature_prefix(sig): Может возвращать префикс, который будет помещён перед именем объекта в сигнатуре.

classcelery.contrib.sphinx.TaskDocumenter(directive:DocumenterBridge, name:str, indent:str='')

Документирование определений задач.

classmethodcan_document_member(member, membername, isattr, parent): Вызывается, чтобы проверить, может ли этот Documenter документировать член.

check_module(): Проверяет, действительно ли self.object определён в модуле, указанном в self.modname.

document_members(all_members=False)

Генерирует reST для документирования членов.

Если all_members равно True, документируются все члены; в противном случае — члены, указанные в self.options.members.

format_args()

Форматирует сигнатуру аргументов self.object.

Если у объекта нет сигнатуры, метод должен возвращать None.

member_order=11: Порядок, если для autodoc_member_order установлено значение ‘groupwise’

objtype='task': Имя, по которому вызывается директива (auto…), и имя директивы, генерируемое по умолчанию

celery.contrib.sphinx.autodoc_skip_member_handler(app, what, name, obj, skip, options): Обработчик события autodoc-skip-member.

celery.contrib.sphinx.setup(app): Настраивает расширение Sphinx.

Copyright © 2017-2026 Asif Saif Uddin, core team & contributors. All rights reserved.
Celery is licensed under The BSD License (3 Clause, also known as the new BSD license). The license is an OSI approved Open Source license and is GPL-compatible.
https://docs.celeryq.dev/en/stable/reference/celery.contrib.sphinx.html