DOC: Add Meson editable quick-start and Windows notes to contributing_environment.rst #62631
Conversation
|
I used an AI assistant to help draft the wording, but I validated and edited it myself and verified the commands locally on Windows. I can open a tracking issue and link it here. |
| Quick start (pip + meson, editable) | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If you just want the fastest route to a working development install using the | ||
| Meson backend through pip (PEP 517), use the following. This performs an | ||
| editable install and will automatically rebuild C/Cython components when | ||
| you import pandas. | ||
|
|
||
| .. code-block:: shell | ||
| # from the repo root, after creating/activating your env | ||
| # fetch tags so the version string can be computed | ||
| git fetch upstream --tags | ||
| # install in editable mode with meson backend | ||
| python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true | ||
| .. tip:: | ||
| Set a build directory to speed up rebuilds by keeping artifacts in one place:: | ||
|
|
||
| python -m pip install -ve . --no-build-isolation \ | ||
| -Cbuilddir=".meson_build" -Csetup-args="-Dbuildtype=debug" | ||
|
|
||
| The ``-Dbuildtype=debug`` flag improves debugging of C extensions. Omit it | ||
| for optimized builds. |
There was a problem hiding this comment.
This feels like a reword of what's written below.
| Windows-specific notes | ||
| ^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| * Ensure the "Build Tools for Visual Studio 2022" with the | ||
| "Desktop development with C++" workload is installed. If Meson cannot | ||
| find ``cl.exe``, add the optional component | ||
| ``MSVC v142 - VS 2019 C++ x64/x86 build tools`` from the installer. | ||
| * Use an elevated "x64 Native Tools Command Prompt for VS 2022" or a standard | ||
| PowerShell where the build tools are on ``PATH``. | ||
| * Long paths: enable them to avoid build errors when the source path is deep:: |
There was a problem hiding this comment.
This feels like a reword of what's written above.
| ^^^^^^^^^^ | ||
|
|
||
| * Verify the install:: | ||
|
|
||
| python -c "import pandas, sys; print(pandas.__version__, sys.executable)" | ||
|
|
||
| * Run a focused test subset before the full suite:: | ||
|
|
||
| pytest pandas/tests/frame/test_constructors.py -q | ||
|
|
||
| The sections below describe the supported build methods in more detail. |
There was a problem hiding this comment.
Similar instructions are written below.
| * To see Meson’s automatic rebuild output on import every time, either pass | ||
| ``-Ceditable-verbose=true`` in the install command (above) or set the env var:: | ||
|
|
||
| set MESONPY_EDITABLE_VERBOSE=1 # PowerShell/cmd (for current session) |
There was a problem hiding this comment.
This is written below.
|
@Alvaro-Kothe |
|
I’ve trimmed the quick-start to a minimal two-command block and removed duplicated Windows/verification content. The section now links to the existing detailed sections (“Build options”, “Checking the build”, “Keeping up to date”) and “Step 1” for Windows toolchain setup. Built docs locally on Windows; the updated section renders as expected. |
|
I agree with @Alvaro-Kothe that this is just summarizing what is on this page, which is also a "quick start" on how to set up a development environment. I think it would be best to open an issue first describing what's lacking from the current setup docs and why it's needed so closing this PR until that discussion is had |
4 participants
doc/source/development/contributing_environment.rst.Motivation
Key changes
git fetch upstream --tagspython -m pip install -ve . --no-build-isolation -Ceditable-verbose=true-Cbuilddir=".meson_build"and-Csetup-args="-Dbuildtype=debug"tipsWindows notes: Build Tools, long paths, execution policy, and
MESONPY_EDITABLE_VERBOSE.Validation steps
htmldocs built locally; the new section renders correctly in:doc/build/html/development/contributing_environment.htmlPlease note that the change is purely documentation; no API or behavior changes.
