Skip to content

Commit

Permalink
Improve editable install explanation in docs
Browse files Browse the repository at this point in the history
Refined the explanation of editable install mode in pip to clarify its
functionality. Improvements include clearer phrasing for better readability
and consistency across installation and development docs.
  • Loading branch information
douglatornell committed Dec 24, 2024
1 parent 603fd10 commit ad92639
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 3 additions & 2 deletions SalishSeaTools/docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion SalishSeaTools/docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit ad92639

Please sign in to comment.