diff --git a/SalishSeaTools/docs/development.rst b/SalishSeaTools/docs/development.rst index e295a377..083eedac 100644 --- a/SalishSeaTools/docs/development.rst +++ b/SalishSeaTools/docs/development.rst @@ -75,10 +75,11 @@ and building the documentation with the commands: :kbd:`SalishSeaTools` is installed in `editable install mode`_ as part of the conda environment creation process. -That means that the package is installed from the cloned repo via symlinks so that -it will be automatically updated as the repo evolves. +That means that the package is installed from the cloned repo in a way that it will be +automatically updated as the repo evolves. .. _editable install mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs + To deactivate the environment use: .. code-block:: bash diff --git a/SalishSeaTools/docs/installation.rst b/SalishSeaTools/docs/installation.rst index ef7783a6..9d9c6e23 100644 --- a/SalishSeaTools/docs/installation.rst +++ b/SalishSeaTools/docs/installation.rst @@ -38,7 +38,9 @@ To install the :kbd:`SalishSeaTools` package in your :kbd:`root` Anaconda or Min $ cd tools $ python -m pip install --editable SalishSeaTools -The :kbd:`--editable` option in the :command:`pip install` commands installs the packages via symlinks so that changes in the package modules will be automatically available in your working environment as the repo evolves. +The :kbd:`--editable` option in the :command:`pip install` commands installs the package +in a way that enables changes in the package modules to be automatically available in your +working environment as the repo evolves. The :kbd:`SalishSeaTools` package can also be installed in an isolated :program:`conda` environment. The common use case for doing so it development,