Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak contributer docs #108

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Tweak contributer docs #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For a development installation (requires Node.js and Yarn):

$ git clone https://github.com/vispy/jupyter_rfb.git
$ cd jupyter_rfb
$ pip install -e .
$ pip install -e .[dev]
$ jupyter nbextension install --py --symlink --overwrite --sys-prefix jupyter_rfb
$ jupyter nbextension enable --py --sys-prefix jupyter_rfb

Expand All @@ -44,20 +44,6 @@ Then you need to rebuild the JS when you make a code change:
You then need to refresh the JupyterLab page when your javascript changes.


Install developer tools
-----------------------

.. code-block::

$ pip install ruff pytest

Install dependencies required for tests
---------------------------------------

.. code-block::

$ pip install pillow simplejpeg

Automated tools
---------------

Expand All @@ -77,3 +63,12 @@ Optionally, you can setup an autocommit hook to automatically run these on each

$ pip install pre-commit
$ pre-commit install


Tips to test changes made to code
---------------------------------

In general you should not have to restart the server when working on the code of jupyter_rfb:

* When Python code has changed: restart and clear all outputs.
* When the JavaScript code has changed: rebuild with yarn, and then refresh (F5) the page.
Loading