From f4e311c09bcb0eb9963dd1b017d6848552735d48 Mon Sep 17 00:00:00 2001 From: Graeme Watt Date: Sat, 14 Oct 2023 23:06:27 +0100 Subject: [PATCH] docs: reinstate SSH URL for "git clone" * Also link to the GitHub docs for both HTTPS URLs and SSH URLs. --- docs/setup.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index e727aa52..ae7af7f9 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -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 git@github.com:HEPData/hepdata_lib.git workon myhepdata # activate virtual environment! pip install -e $SOMEPATH/hepdata_lib