Skip to content

Commit 1fb0e25

Browse files
authored
apacheGH-49572 : [Python][Docs] Remove editable section and consolidate the information (apache#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: apache#49572 Authored-by: AlenkaF <frim.alenka@gmail.com> Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
1 parent 2c2a61c commit 1fb0e25

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

docs/source/developers/python/building.rst

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,11 @@ To build PyArrow run:
434434
Note that bundled Arrow C++ libraries will not be automatically
435435
updated when rebuilding Arrow C++.
436436

437+
This creates an *editable install*, meaning changes to the Python source code
438+
will be reflected immediately without needing to reinstall the package.
439+
The ``--no-build-isolation`` flag ensures that the build uses your current
440+
environment's dependencies instead of creating an isolated one.
441+
437442
To set the number of threads used to compile PyArrow's C++/Cython components,
438443
set the ``CMAKE_BUILD_PARALLEL_LEVEL`` environment variable.
439444

@@ -450,7 +455,7 @@ A ``relwithdebinfo`` build can be created similarly.
450455
Self-Contained Wheel
451456
^^^^^^^^^^^^^^^^^^^^
452457

453-
If you're preparing a PyArrow wheel for distribution (e.g., for PyPI), youll
458+
If you're preparing a PyArrow wheel for distribution (e.g., for PyPI), you'll
454459
need to build a self-contained wheel (including the Arrow and Parquet C++
455460
libraries). This ensures that all necessary native libraries are bundled inside
456461
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
467472
This option is typically only needed for releases or distribution scenarios,
468473
not for local development.
469474

470-
Editable install
471-
^^^^^^^^^^^^^^^^
472-
473-
To install an editable PyArrow build, run the following command from the
474-
``arrow/python`` directory:
475-
476-
.. code-block::
477-
478-
pip install -e . --no-build-isolation
479-
480-
This creates an *editable install*, meaning changes to the Python source code
481-
will be reflected immediately without needing to reinstall the package.
482-
The ``--no-build-isolation`` flag ensures that the build uses your current
483-
environment's dependencies instead of creating an isolated one. This is
484-
especially useful during development and debugging.
485-
486475
.. _stale_artifacts:
487476

488477
Deleting stale build artifacts

0 commit comments

Comments
 (0)