Merge pull request #7947 from pradyunsg/docs/nicer-formatting-vcs-support

Use a code block for denoting directory structure
This commit is contained in:
Pradyun Gedam 2020-04-01 18:15:03 +05:30 committed by GitHub
commit 0c30b45ce2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions

View File

@ -384,18 +384,18 @@ where ``setup.py`` is not in the root of project, the "subdirectory" component
is used. The value of the "subdirectory" component should be a path starting
from the root of the project to where ``setup.py`` is located.
So if your repository layout is:
If your repository layout is::
- pkg_dir/
pkg_dir
├── setup.py # setup.py for package "pkg"
└── some_module.py
other_dir
└── some_file
some_other_file
- setup.py # setup.py for package ``pkg``
- some_module.py
- other_dir/
Then, to install from this repository, the syntax would be::
- some_file
- some_other_file
You'll need to use ``pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"``.
$ pip install -e "vcs+protocol://repo_url/#egg=pkg&subdirectory=pkg_dir"
Git