Pip install doesn't use editable option.

[coady]

Details

The yaml config documentation states that pip install is run in editable mode:

Expected Result

Behind the scene the following Pip command will be run:

$ pip install -e .[tests,docs]

Actual Result

But it doesn't use the -e option. This can break builds which rely on setting a relative path in docs/conf.py.

[humitos]

You are right.

I think we should remove the -e from the documentation.

This can break builds which rely on setting a relative path in docs/conf.py.

This doesn't sound like a good way to configure the project to me.

[coady]

This can break builds which rely on setting a relative path in docs/conf.py.

This doesn't sound like a good way to configure the project to me.

Well sphinx actually encourages it, particularly with autodoc. From its default conf.py:

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

[stsewd]

I don't see any mention of installing the package in dev mode when modifying the path.

[monsij]

Is a PR still required @coady

[stsewd]

@monsij yes, it is.

[monsij]

Could you describe what is to be done ? -e removal ..anything else?

[stsewd]

Just that #4944 (comment)

[dojutsu-user]

@monsij
Are you working on this?
If not, I would like to send a PR.

[monsij]

Yeah,i've started to work. Anyways you can continue. I'll find another :-) @dojutsu-user

[dojutsu-user]

@monsij
I was about to start the work.
You can continue and make a PR.