fix the dead link to python environments for development

supernnova · Sep 18, 2024 · 43fdcf2 · 43fdcf2
1 parent 1aa6760
commit 43fdcf2
Show file tree

Hide file tree

Showing 4 changed files with 753 additions and 732 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -63,13 +63,6 @@ Welcome to SuperNNova's documentation!
    paper/index.rst
    paper/paper.rst
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
-   :caption: Implemenatation of SWAG
-
-   Implementation of SWAG <swag_implementation>
-
 .. toctree::
    :glob:
    :maxdepth: 1

diff --git a/docs/installation/python.rst b/docs/installation/python.rst
@@ -45,7 +45,7 @@ if you create environment from "conda_gpu_env.yml".
     which poetry # should print <conda env>/bin/poetry
     poetry install
 
-For developers, please refer to `Notes for Developers <../notes_for_developers.md# Installing Development Dependencies>`_.
+For developers, please refer to :ref:`dev-python-env`.
 
 
 .. _DockerConfigurations:

diff --git a/docs/notes_for_developers.md b/docs/notes_for_developers.md
@@ -40,6 +40,7 @@ A local development copy of the code base can be obtained and configured as foll
 Although not strictly necessary, it is recommended that you configure the branch permissions of any forked repositories as detailed in the *GitHub* configuration section below.
 :::
 
+(dev-python-env)=
 # Python environments for development
 
 Python development should always be managed using a Python environment. Both Conda and Poetry ([see here for an introduction](https://python-poetry.org)) are used to manage this project. It simplifies & helps with managing the following: