Skip to content

Commit b13b468

Browse files
committed
Update start.rst
Added a link to PEP 668 in the virtual environment section
1 parent 55903af commit b13b468

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/apache-airflow/start.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ constraint files to enable reproducible installation, so using ``pip`` and const
4747
1. **(Recommended) Create and Activate a Virtual Environment**:
4848

4949
To avoid issues such as the `externally-managed-environment` error, particularly on modern Linux distributions like Ubuntu 22.04+ and Debian 12+, it is highly recommended to install Airflow inside a Python virtual environment. This approach prevents conflicts with system-level Python packages and ensures smooth installation.
50+
51+
For more details on this error, see the Python Packaging Authority's explanation in the `PEP 668 documentation <https://peps.python.org/pep-0668/>`_.
5052

5153
.. code-block:: bash
5254
@@ -71,7 +73,7 @@ constraint files to enable reproducible installation, so using ``pip`` and const
7173
export AIRFLOW_HOME=~/airflow
7274
7375
74-
2. Install Airflow using the constraints file, which is determined based on the URL we pass:
76+
3. Install Airflow using the constraints file, which is determined based on the URL we pass:
7577

7678
.. code-block:: bash
7779
:substitutions:
@@ -88,15 +90,15 @@ constraint files to enable reproducible installation, so using ``pip`` and const
8890
8991
pip install "apache-airflow==${AIRFLOW_VERSION}" --constraint "${CONSTRAINT_URL}"
9092
91-
3. Run Airflow Standalone:
93+
4. Run Airflow Standalone:
9294

9395
The ``airflow standalone`` command initializes the database, creates a user, and starts all components.
9496

9597
.. code-block:: bash
9698
9799
airflow standalone
98100
99-
4. Access the Airflow UI:
101+
5. Access the Airflow UI:
100102

101103
Visit ``localhost:8080`` in your browser and log in with the admin account details shown in the terminal. Enable the ``example_bash_operator`` DAG in the home page.
102104

0 commit comments

Comments
 (0)