Skip to content

Commit

Permalink
cleanup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
magland committed Nov 8, 2023
1 parent 867ef61 commit 5b3f900
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 34 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ See the [examples folder](./examples) or the [example notebook](./notebooks/sort

SortingView widgets can be viewed in any of the following modes:
* shareable URL in the browser
* [local URL in the browser](./doc/local_mode.md)
* [electron desktop window](./doc/electron_mode.md)
* [jupyter widget](./doc/jupyter_integration.md)
* [jupyter widget](./doc/jupyter_integration.md) (probably not working - needs to be updated)

## SpikeInterface Integration

Expand Down
15 changes: 0 additions & 15 deletions doc/electron_mode.md

This file was deleted.

2 changes: 2 additions & 0 deletions doc/features.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:warning: This is outdated. Needs to be updated.

|Feature | Status|Notes|
|-----|------|----|
|Shareable URLs|:heavy_check_mark:||
Expand Down
2 changes: 2 additions & 0 deletions doc/jupyter_integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Jupyter integration

:warning: This is probably not working. Needs to be updated.

You can also view sortingview widgets directly in Jupyter lab or Jupyter notebook. As with [local mode](./local_mode.md) and [electron mode](./electron_mode.md), no data goes to the cloud, and the front-end simply communicates with the python kernel. It uses the [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/) mechanism.

After creating a view, simply use the following command in the notebook cell.
Expand Down
16 changes: 0 additions & 16 deletions doc/local_mode.md

This file was deleted.

0 comments on commit 5b3f900

Please sign in to comment.