Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for packages - 2025-01-26 #1118

Merged
merged 1 commit into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4fee04512f6c9b7b60a64a7081245e61
tags: 645f666f9bcd5a90fca523b33c5a78b7

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
airflow.providers.celery.cli.celery_command
===========================================

.. py:module:: airflow.providers.celery.cli.celery_command

.. autoapi-nested-parse::

Celery command.



Attributes
----------

.. autoapisummary::

airflow.providers.celery.cli.celery_command.WORKER_PROCESS_NAME


Functions
---------

.. autoapisummary::

airflow.providers.celery.cli.celery_command.flower
airflow.providers.celery.cli.celery_command.logger_setup_handler
airflow.providers.celery.cli.celery_command.worker
airflow.providers.celery.cli.celery_command.stop_worker


Module Contents
---------------

.. py:data:: WORKER_PROCESS_NAME
:value: 'worker'


.. py:function:: flower(args)

Start Flower, Celery monitoring tool.


.. py:function:: logger_setup_handler(logger, **kwargs)

Reconfigure the logger.

* remove any previously configured handlers
* logs of severity error, and above goes to stderr,
* logs of severity lower than error goes to stdout.


.. py:function:: worker(args)

Start Airflow Celery worker.


.. py:function:: stop_worker(args)

Send SIGTERM to Celery worker.


Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
airflow.providers.celery.cli
============================

.. py:module:: airflow.providers.celery.cli


Submodules
----------

.. toctree::
:maxdepth: 1

/_api/airflow/providers/celery/cli/celery_command/index


Loading
Loading