update reference labels and conf.py

ivadomed · Jul 4, 2022 · 31d127e · 31d127e
1 parent 23ec42a
commit 31d127e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 9 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -14,12 +14,12 @@ Thank you for your interest in contributing to ivadomed! This project uses the f
     towards any contribution.
 
   * The `NeuroPoly Contributing Guidelines <https://intranet.neuro.polymtl.ca/software-development/contributing>`_ 
-  provide instructions for development workflows, such as reporting issues or submitting pull requests.
+    provide instructions for development workflows, such as reporting issues or submitting pull requests.
 
   * The `ivadomed Developer Wiki <https://github.com/ivadomed/ivadomed/wiki>`_
-  acts as a knowledge base for documenting internal design decisions specific
-  to the ivadomed codebase. It also contains step-by-step walkthroughs for
-  common ivadomed maintainer tasks.
+    acts as a knowledge base for documenting internal design decisions specific
+    to the ivadomed codebase. It also contains step-by-step walkthroughs for
+    common ivadomed maintainer tasks.
 
 Contributor or Developer ``ivadomed`` installation 
 ++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -53,7 +53,7 @@ Contributor or Developer ``ivadomed`` installation
             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:`docs/source/installation::installation-step1` .
+            by following the instructions as specified in the :ref:`installation` .
 
             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

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -96,6 +96,7 @@ def patched_parse(self):
 autoclass_content = "both"
 add_module_names = True
 autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth >= 2
 autodoc_default_options = {
     'members': None,
     'member-order': 'bysource',  # 'alphabetical'

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,4 +1,3 @@
-.. _installation:
 Installation
 ============
 
@@ -7,8 +6,7 @@ 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
 ++++++++++++++++++++++++++++++++++++++++++++++
 
@@ -102,7 +100,6 @@ 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``
 ++++++++++++++++++++++++++++