Skip to content

DOC: Add note for building with setuptools #53227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 17, 2023
Merged

DOC: Add note for building with setuptools #53227

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78c72b7
DOC: Add note for building with setuptools
phofl May 14, 2023
ebc08be
Update doc/source/development/contributing_environment.rst
phofl May 16, 2023
3f1fbb1
Update
phofl May 16, 2023
8222205
Merge remote-tracking branch 'upstream/main' into doc_meson
phofl May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/source/development/contributing_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,15 @@ To compile pandas with setuptools, run::

python setup.py develop

.. note::
If pandas is already installed (via meson), you have to uninstall it first::

python -m pip uninstall pandas

This is because python setup.py develop will not uninstall the loader script that ``meson-python``
uses to import the extension from the build folder, which may cause errors such as an
``FileNotFoundError`` to be raised.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is good to add the context for why you should uninstall it.

e.g.
"This is because python setup.py develop will not uninstall the loader script that meson-python uses to import the extension from the build folder, which may cause errors such as an FileNotFoundError to be raised."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

.. note::
You will need to repeat this step each time the C extensions change, for example
if you modified any file in ``pandas/_libs`` or if you did a fetch and merge from ``upstream/main``.
Expand Down