Skip to content

Commit

Permalink
Update jdaviz developer installation instructions (#2569)
Browse files Browse the repository at this point in the history
* In installation.rst, changed the order of dev install steps, added IPython magic commands, and added description to code contribution section

* Added a note to install first without -e flag to obtain template files

---------

Co-authored-by: Gilbert Green <[email protected]>
  • Loading branch information
gibsongreen and Gilbert Green authored Nov 16, 2023
1 parent c3d81ba commit ac3078a
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,19 +108,12 @@ You also need the up-to-date tags for proper software versioning:
git rebase upstream/main
For the rest of contributing workflow, it is very similar to
`how to make code contribution to astropy <https://docs.astropy.org/en/latest/development/workflow/development_workflow.html>`_,
except for the change log.
If your patch requires a change log, see ``CHANGES.rst`` for examples.
`how to make a code contribution to astropy <https://docs.astropy.org/en/latest/development/workflow/development_workflow.html>`_,
including setting up virtual environments, git basics, and more.

To install ``jdaviz`` for development or from source in an editable mode
(i.e., changes to the locally checked out code would reflect in runtime
after you restarted the Python kernel):
An exception is the change log; if your patch requires a change log, see ``CHANGES.rst`` for examples.

.. code-block:: bash
pip install -e .
Optionally, to enable the hot reloading of Vue.js templates, install
One option is to enable the hot reloading of Vue.js templates, install
``watchdog``:

.. code-block:: bash
Expand All @@ -134,3 +127,23 @@ of a notebook:
from jdaviz import enable_hot_reloading
enable_hot_reloading()
Another option is to enable magic commands for Python autoreloading, to use it,
add the following to the top of a notebook:

.. code-block:: python
%load_ext autoreload
%autoreload 2
To install ``jdaviz`` for development or from source in an editable mode
(i.e., changes to the locally checked out code would reflect in runtime
after you restarted the Python kernel):

.. code-block:: bash
pip install -e .
Note: It is recommended to install the package without ``-e`` flag initially
to ensure that the template files are copied correctly.

0 comments on commit ac3078a

Please sign in to comment.