diff --git a/doc/source/development/contributing_environment.rst b/doc/source/development/contributing_environment.rst index c09e8595f0241..ec942049950ff 100644 --- a/doc/source/development/contributing_environment.rst +++ b/doc/source/development/contributing_environment.rst @@ -211,6 +211,26 @@ for :ref:`building pandas with GitPod `. Step 3: build and install pandas -------------------------------- +Quick start (pip + meson, editable) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Fastest route to a working development install using pip+Meson (PEP 517). This +performs an editable install that auto-rebuilds C/Cython components on import: + +.. code-block:: shell + + # from the repo root, after creating/activating your env + git fetch upstream --tags + python -m pip install -ve . --no-build-isolation + +For Windows compiler setup, Meson build options (e.g. build directory, debug), +how to verify the build, and how to see Meson’s editable rebuild output, see the +sections below: "Build options", "Checking the build", and "Keeping up to date +with the latest build". Windows toolchain requirements are covered in "Step 1: +install a C compiler" above. + +The sections below describe the supported build methods in more detail. + There are currently two supported ways of building pandas, pip/meson and setuptools(setup.py). Historically, pandas has only supported using setuptools to build pandas. However, this method requires a lot of convoluted code in setup.py and also has many issues in compiling pandas in parallel