Skip to content
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.

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

direct-url: Wrap pip commands with backticks #973

Merged
merged 4 commits into from
Sep 3, 2021
Merged
Changes from 1 commit
Commits
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
18 changes: 9 additions & 9 deletions source/specifications/direct-url.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,18 +278,18 @@ Example pip commands and their effect on direct_url.json

Commands that generate a ``direct_url.json``:

* pip install https://example.com/app-1.0.tgz
* pip install https://example.com/app-1.0.whl
* pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"
* pip install ./app
* pip install file:///home/user/app
* pip install --editable "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"
* ``pip install https://example.com/app-1.0.tgz``
* ``pip install https://example.com/app-1.0.whl``
* ``pip install "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"``
* ``pip install ./app``
* ``pip install file:///home/user/app``
* ``pip install --editable "git+https://example.com/repo/app.git#egg=app&subdirectory=setup"``
(in which case, ``url`` will be the local directory where the git repository has been
cloned to, and ``dir_info`` will be present with ``"editable": true`` and no
``vcs_info`` will be set)
dukecat0 marked this conversation as resolved.
Show resolved Hide resolved
* pip install -e ./app
* ``pip install -e ./app``
dukecat0 marked this conversation as resolved.
Show resolved Hide resolved

Commands that *do not* generate a ``direct_url.json``

* pip install app
* pip install app --no-index --find-links https://example.com/
* ``pip install app``
* ``pip install app --no-index --find-links https://example.com/``