add reference labels to internally reference

installation steps
ivadomed · Jul 2, 2022 · 27cdc8d · 27cdc8d
1 parent c94f119
commit 27cdc8d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 21 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -27,13 +27,21 @@ Contributor or Developer ``ivadomed`` installation
             <https://docs.nvidia.com/deploy/cuda-compatibility/index.html#minor-version-compatibility>`_.
             And, for CUDA 11.1 you'd need an upgraded NVIDIA driver version >=450.
 
-            To verify the NVIDIA driver version, just look in ``/sys`` by 
-            executing the command ``cat /sys/module/nvidia/version`` and you'll find 
-            your current driver version.
+            To verify the NVIDIA driver version, look in ``/sys`` by executing the
+            command:
+
+            ::
+
+                cat /sys/module/nvidia/version
+                
+            and it will return your current driver version.
 
             Before proceeding with the installation, we suggest you to set up a virtual environment
-            by following the instructions as specified in the :ref:`Step 1 of the installation procedure <just-a-label>`.
-            ``ivadomed`` from source along with additional dependencies related to building documentation and testing:
+            by following the instructions as specified in the :ref:`installation-step1`.
+
+            Once you've set up a virtual environment and activated it, we recommend installing 
+            ``ivadomed`` from source along with some additional dependencies related to building
+            documentation, linting and testing:
 
             .. tabs::
 
@@ -53,11 +61,11 @@ Contributor or Developer ``ivadomed`` installation
 
                     ::
 
-                    git clone https://github.com/ivadomed/ivadomed.git
+                        git clone https://github.com/ivadomed/ivadomed.git
 
-                    cd ivadomed
+                        cd ivadomed
 
-                    pip install -e .[dev] --extra-index-url https://download.pytorch.org/whl/cu111
+                        pip install -e .[dev] --extra-index-url https://download.pytorch.org/whl/cu111
 
                 .. tab:: Mac/Windows
 
@@ -97,17 +105,7 @@ Contributor or Developer ``ivadomed`` installation
 
                         pip install -e .[dev] --extra-index-url https://download.pytorch.org/whl/cpu
 
-                .. tab:: Mac/Windows 
-
-                    ::
-
-                        git clone https://github.com/ivadomed/ivadomed.git
-
-                        cd ivadomed
-
-                        pip install -e .[dev]
-
-                .. tab:: Mac
+                .. tab:: Mac/Windows
 
                     ::
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,13 +1,14 @@
+.. _installation:
 Installation
 ============
 
-
 Supported OS
 ++++++++++++
 
     ``ivadomed`` officially supports GPU acceleration only on ``Linux`` and CPU on ``Linux``, 
     ``Windows`` and ``MacOS``.
 
+.. _installation-step1:
 Step 1: Set up a dedicated virtual environment
 +++++++++++++++++++++++++++++++++++++++++++++
 
@@ -101,7 +102,7 @@ Step 1: Set up a dedicated virtual environment
 
             If you are using `Compute Canada <https://www.computecanada.ca/>`_, you can load modules as `mentioned here <https://intranet.neuro.polymtl.ca/computing-resources/compute-canada#modules>`_ and `also here <https://docs.computecanada.ca/wiki/Utiliser_des_modules/en#Loading_modules_automatically>`_.
 
-
+.. _installation-step2:
 Step 2: Install ``ivadomed``
 ++++++++++++++++++++++++++++