In-place developer installation instructions
Hi all, I noticed that the pip developer installation instructions are missing from the documentation. The instructions are in quickstart_pip.rst, but I don't see that included in contributor/index.rst. Besides that, the instructions do not show how to build in-place and then install that SciPy so it can be used locally. I would expect something like: pip install --no-build-isolation -e . Or: python setup.py build_ext -i Then add SciPy to the PYTHONPATH. If I can get a sense of what the instructions should look like, I'd be happy to file a PR. Best regards, Stéfan
On Fri, Aug 6, 2021 at 7:20 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
Hi all,
I noticed that the pip developer installation instructions are missing from the documentation. The instructions are in quickstart_pip.rst, but I don't see that included in contributor/index.rst.
Besides that, the instructions do not show how to build in-place and then install that SciPy so it can be used locally. I would expect something like:
pip install --no-build-isolation -e .
Or:
python setup.py build_ext -i
Then add SciPy to the PYTHONPATH.
If I can get a sense of what the instructions should look like, I'd be happy to file a PR.
Hey Stéfan, `build_ext` is used in the main "development workflow" guide: http://scipy.github.io/devdocs/dev/contributor/development_workflow.html#bas..., and in several other guides. We already have too many guides; there's a tracking issue about reducing that complexity to make it easier to navigate. Subtracting >= adding here. I would not recommend using `pip -e`, it's worse than `setup.py build_ext -i` or `setup.py develop`. Cheers, Ralf
On Fri, Aug 6, 2021, at 11:21, Ralf Gommers wrote:
Hey Stéfan, `build_ext` is used in the main "development workflow" guide: http://scipy.github.io/devdocs/dev/contributor/development_workflow.html#bas..., and in several other guides. We already have too many guides; there's a tracking issue about reducing that complexity to make it easier to navigate. Subtracting >= adding here.
Great, thanks for the pointer. We can also remove the files not used in the documentation (or were they left there for a reason? I see that one has an explicit orphan tag.)
I would not recommend using `pip -e`, it's worse than `setup.py build_ext -i` or `setup.py develop`.
What caught me by surprise is that the instructions stop after the in-place build step, but without showing how to add it to the Python path (instead simply pointing to the runtest script). Stéfan
On Sat, Aug 7, 2021 at 10:51 PM Stefan van der Walt <stefanv@berkeley.edu> wrote:
On Fri, Aug 6, 2021, at 11:21, Ralf Gommers wrote:
Hey Stéfan, `build_ext` is used in the main "development workflow" guide: http://scipy.github.io/devdocs/dev/contributor/development_workflow.html#bas..., and in several other guides. We already have too many guides; there's a tracking issue about reducing that complexity to make it easier to navigate. Subtracting >= adding here.
Great, thanks for the pointer. We can also remove the files not used in the documentation (or were they left there for a reason? I see that one has an explicit orphan tag.)
I'm not sure which files those are. Some orphan tags are on purpose (like for class methods/attributes IIRC), but not for narrative docs AFAIK.
I would not recommend using `pip -e`, it's worse than `setup.py build_ext -i` or `setup.py develop`.
What caught me by surprise is that the instructions stop after the in-place build step, but without showing how to add it to the Python path (instead simply pointing to the runtest script).
Yes, that is worth fixing. Cheers, Ralf
participants (2)
-
Ralf Gommers -
Stefan van der Walt