This is an automated email from the ASF dual-hosted git repository.
raulcd pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 1fb0e25a36 GH-49572 : [Python][Docs] Remove editable section and
consolidate the information (#49573)
1fb0e25a36 is described below
commit 1fb0e25a36851d1b08a0730d29e0d25680bcf038
Author: Alenka Frim <[email protected]>
AuthorDate: Wed Mar 25 11:28:00 2026 +0100
GH-49572 : [Python][Docs] Remove editable section and consolidate the
information (#49573)
### Rationale for this change
Editable install section in the Python dev docs became redundant with the
new scikit-build-core backend.
### What changes are included in this PR?
Update docs.
### Are these changes tested?
No, just docs changes.
### Are there any user-facing changes?
No.
* GitHub Issue: #49572
Authored-by: AlenkaF <[email protected]>
Signed-off-by: Raúl Cumplido <[email protected]>
---
docs/source/developers/python/building.rst | 23 ++++++-----------------
1 file changed, 6 insertions(+), 17 deletions(-)
diff --git a/docs/source/developers/python/building.rst
b/docs/source/developers/python/building.rst
index 39d72b7c7d..1d40d78f0a 100644
--- a/docs/source/developers/python/building.rst
+++ b/docs/source/developers/python/building.rst
@@ -434,6 +434,11 @@ To build PyArrow run:
Note that bundled Arrow C++ libraries will not be automatically
updated when rebuilding Arrow C++.
+This creates an *editable install*, meaning changes to the Python source code
+will be reflected immediately without needing to reinstall the package.
+The ``--no-build-isolation`` flag ensures that the build uses your current
+environment's dependencies instead of creating an isolated one.
+
To set the number of threads used to compile PyArrow's C++/Cython components,
set the ``CMAKE_BUILD_PARALLEL_LEVEL`` environment variable.
@@ -450,7 +455,7 @@ A ``relwithdebinfo`` build can be created similarly.
Self-Contained Wheel
^^^^^^^^^^^^^^^^^^^^
-If you're preparing a PyArrow wheel for distribution (e.g., for PyPI), you’ll
+If you're preparing a PyArrow wheel for distribution (e.g., for PyPI), you'll
need to build a self-contained wheel (including the Arrow and Parquet C++
libraries). This ensures that all necessary native libraries are bundled inside
the wheel, so users can install it without needing to have Arrow or Parquet
@@ -467,22 +472,6 @@ To do this, set the ``PYARROW_BUNDLE_ARROW_CPP``
environment variable before bui
This option is typically only needed for releases or distribution scenarios,
not for local development.
-Editable install
-^^^^^^^^^^^^^^^^
-
-To install an editable PyArrow build, run the following command from the
-``arrow/python`` directory:
-
-.. code-block::
-
- pip install -e . --no-build-isolation
-
-This creates an *editable install*, meaning changes to the Python source code
-will be reflected immediately without needing to reinstall the package.
-The ``--no-build-isolation`` flag ensures that the build uses your current
-environment's dependencies instead of creating an isolated one. This is
-especially useful during development and debugging.
-
.. _stale_artifacts:
Deleting stale build artifacts