-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: reinstate SSH URL for "git clone"
* Also link to the GitHub docs for both HTTPS URLs and SSH URLs.
- Loading branch information
1 parent
c5f19db
commit f4e311c
Showing
1 changed file
with
7 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,12 +42,18 @@ Setup for developers | |
|
||
The general comments about installing a python package (see :ref:`sec-setup-users`) apply here, too. Use a virtual environment (see :ref:`sec-setup-virtualenv`)! | ||
|
||
If you would like to develop the code, you need to install the package from the up-to-date git repository rather than the stable release in pypi. To do this, you can use the pip `-e` syntax: | ||
If you would like to develop the code, you need to install the package from the up-to-date `GitHub repository`_ rather than the stable release in PyPI. To do this, you can use the pip `-e` syntax. | ||
The GitHub repository can be cloned using either an `HTTPS URL`_ or an `SSH URL`_. | ||
|
||
.. _GitHub repository: https://github.com/HEPData/hepdata_lib | ||
.. _HTTPS URL: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls | ||
.. _SSH URL: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-ssh-urls | ||
|
||
:: | ||
|
||
cd $SOMEPATH | ||
git clone https://github.com/HEPData/hepdata_lib.git | ||
OR git clone [email protected]:HEPData/hepdata_lib.git | ||
|
||
workon myhepdata # activate virtual environment! | ||
pip install -e $SOMEPATH/hepdata_lib | ||
|