This is an automated email from the ASF dual-hosted git repository.
vincbeck pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 0f465c3c16 Fix bash command formatting in docs (#38335)
0f465c3c16 is described below
commit 0f465c3c161b9af3335866a9008a001f9ce8dc36
Author: Vincent <[email protected]>
AuthorDate: Wed Mar 20 16:36:17 2024 -0300
Fix bash command formatting in docs (#38335)
---
contributing-docs/03_contributors_quick_start.rst | 2 +-
.../contributors_quick_start_gitpod.rst | 2 +-
dev/breeze/doc/01_installation.rst | 2 +-
dev/breeze/doc/05_test_commands.rst | 24 +++++++++++-----------
4 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/contributing-docs/03_contributors_quick_start.rst
b/contributing-docs/03_contributors_quick_start.rst
index d94a611d87..4a6f0d7207 100644
--- a/contributing-docs/03_contributors_quick_start.rst
+++ b/contributing-docs/03_contributors_quick_start.rst
@@ -239,7 +239,7 @@ Setting up Breeze
The workaround is to downgrade packaging to 23.1 and re-running the ``pipx
install`` command, for example
by running ``pip install "packaging<23.2"``.
- .. code-block::bash
+ .. code-block:: bash
pip install "packaging==23.1"
pipx install -e ./dev/breeze --force
diff --git
a/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
b/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
index 1809f519e7..0bb9e0f1c0 100644
--- a/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
+++ b/contributing-docs/quick-start-ide/contributors_quick_start_gitpod.rst
@@ -68,7 +68,7 @@ Gitpod default image have all the required packages installed.
The workaround is to downgrade packaging to 23.1 and re-running the ``pipx
install`` command. for example
by running ``pip install "packaging<23.2"``.
- .. code-block::bash
+ .. code-block:: bash
pip install "packaging==23.1"
pipx install -e ./dev/breeze --force
diff --git a/dev/breeze/doc/01_installation.rst
b/dev/breeze/doc/01_installation.rst
index f82fdbe651..f120652f58 100644
--- a/dev/breeze/doc/01_installation.rst
+++ b/dev/breeze/doc/01_installation.rst
@@ -251,7 +251,7 @@ Run this command to install Breeze (make sure to use ``-e``
flag):
The workaround is to downgrade packaging to 23.1 and re-running the ``pipx
install`` command.
- .. code-block::bash
+ .. code-block:: bash
pip install "packaging<23.2"
pipx install -e ./dev/breeze --force
diff --git a/dev/breeze/doc/05_test_commands.rst
b/dev/breeze/doc/05_test_commands.rst
index abbc84b636..5834b76b8a 100644
--- a/dev/breeze/doc/05_test_commands.rst
+++ b/dev/breeze/doc/05_test_commands.rst
@@ -427,13 +427,13 @@ for all clusters in parallel.
Run all tests:
-.. code-block::bash
+.. code-block:: bash
breeze k8s tests
Run selected tests:
-.. code-block::bash
+.. code-block:: bash
breeze k8s tests test_kubernetes_executor.py
@@ -449,7 +449,7 @@ shell command directly. In case the shell parameters are
the same as the paramet
can pass them after ``--``. For example this is the way how you can see all
available parameters of the shell
you have:
-.. code-block::bash
+.. code-block:: bash
breeze k8s tests -- --help
@@ -458,7 +458,7 @@ with the specifications of tests you want to run. For
example the command below
``test_kubernetes_executor.py`` and will suppress capturing output from Pytest
so that you can see the
output during test execution.
-.. code-block::bash
+.. code-block:: bash
breeze k8s tests -- test_kubernetes_executor.py -s
@@ -471,13 +471,13 @@ to run the whole chains in parallel.
Run all tests:
-.. code-block::bash
+.. code-block:: bash
breeze k8s run-complete-tests
Run selected tests:
-.. code-block::bash
+.. code-block:: bash
breeze k8s run-complete-tests test_kubernetes_executor.py
@@ -493,7 +493,7 @@ shell command directly. In case the shell parameters are
the same as the paramet
can pass them after ``--``. For example this is the way how you can see all
available parameters of the shell
you have:
-.. code-block::bash
+.. code-block:: bash
breeze k8s run-complete-tests -- --help
@@ -502,7 +502,7 @@ with the specifications of tests you want to run. For
example the command below
``test_kubernetes_executor.py`` and will suppress capturing output from Pytest
so that you can see the
output during test execution.
-.. code-block::bash
+.. code-block:: bash
breeze k8s run-complete-tests -- test_kubernetes_executor.py -s
@@ -517,7 +517,7 @@ cluster pre-configured. This is done via ``breeze k8s
shell`` command.
Once you are in the shell, the prompt will indicate which cluster you are
interacting with as well
as executor you use, similar to:
-.. code-block::bash
+.. code-block:: bash
(kind-airflow-python-3.9-v1.24.0:KubernetesExecutor)>
@@ -526,7 +526,7 @@ The shell automatically activates the virtual environment
that has all appropria
installed and you can interactively run all k8s tests with pytest command (of
course the cluster need to
be created and airflow deployed to it before running the tests):
-.. code-block::bash
+.. code-block:: bash
(kind-airflow-python-3.9-v1.24.0:KubernetesExecutor)> pytest
test_kubernetes_executor.py
================================================= test session starts
=================================================
@@ -562,7 +562,7 @@ shell command directly. In case the shell parameters are
the same as the paramet
can pass them after ``--``. For example this is the way how you can see all
available parameters of the shell
you have:
-.. code-block::bash
+.. code-block:: bash
breeze k8s shell -- --help
@@ -585,7 +585,7 @@ You can also specify any ``k9s`` flags and commands as
extra parameters - they w
can pass them after ``--``. For example this is the way how you can see all
available parameters of the
``k9s`` you have:
-.. code-block::bash
+.. code-block:: bash
breeze k8s k9s -- --help
