add basic example for subdirectory

closes #2457
This commit is contained in:
Xavier Fernandez 2015-11-03 22:33:48 +01:00
parent 8e22a94f41
commit e2c9a0f743
1 changed files with 17 additions and 0 deletions

View File

@ -289,6 +289,23 @@ where setup.py is not in the root of project, "subdirectory" component
is used. Value of "subdirectory" component should be a path starting from root
of the project to where setup.py is located.
So if your repository layout is:
- pkg_dir/
- setup.py # setup.py for package ``pkg``
- some_module.py
- other_dir/
- some_file
- some_other_file
You'll need to use ``pip install -e vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir``.
.. note::
The subdirectory component can currently only be used for editable installs.
Git
~~~