Skip to content

Commit 2ed8526

Browse files
committed
Updated links with absolute paths and deleted dead code
1 parent 62af95d commit 2ed8526

File tree

5 files changed

+15
-132
lines changed

5 files changed

+15
-132
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ Click the icon below to launch a notebook:
105105
* Wait for the MATLAB session to start. This can take several minutes.
106106
* **NOTE**: All notebooks in a Jupyter server share the same underlying MATLAB process. Executing code in one notebook will effect the workspace in other notebooks. Users must be mindful of this while working with multiple notebooks at the same time.
107107
* **For MATLAB R2022b and later:** Local functions can be defined at the end of a cell for use in the same cell
108-
![cellLocalFunctions](img/cell-local-function.png)
108+
![cellLocalFunctions](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/cell-local-function.png)
109109

110-
For more information, see [MATLAB Kernel for Jupyter](src/jupyter_matlab_kernel/README.md).
110+
For more information, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).
111111

112112
### **Open MATLAB: Open a browser-based version of the MATLAB development environment from Jupyter**
113113
Click the icon below to open a browser-based version of the MATLAB development environment:
@@ -116,9 +116,9 @@ Click the icon below to open a browser-based version of the MATLAB development e
116116
|<p align="center"><img width="100" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlab-desktop-button.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyter_matlab_desktop.png"></p> |
117117

118118
* Notebooks in JupyterLab, also have a `Open MATLAB` shortcut on the top to access the MATLAB desktop.
119-
|![open-matlab-button](img/open-matlab-button.png)
119+
|![open-matlab-button](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open-matlab-button.png)
120120

121-
For more information, see [Open MATLAB in a browser](src/jupyter_matlab_proxy/README.md).
121+
For more information, see [Open MATLAB in a browser](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_proxy/README.md).
122122

123123

124124
### **MATLAB File: Open a new MATLAB file (.m) in JupyterLab**
@@ -152,7 +152,7 @@ A reference architecture that installs `jupyter-matlab-proxy` in a Docker image
152152

153153
* Notebooks running on the same server share the same MATLAB. It is currently not possible to have separate workspaces for each notebook.
154154

155-
* Kernels cannot restart MATLAB automatically when users explicitly terminate their MATLAB session using the `exit` command or through the browser-based MATLAB development environment. Users must manually restart MATLAB using the options shown [here](/src/jupyter_matlab_proxy/README.md/#usage).
155+
* Kernels cannot restart MATLAB automatically when users explicitly terminate their MATLAB session using the `exit` command or through the browser-based MATLAB development environment. Users must manually restart MATLAB using the options shown [here](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_proxy/README.md/#usage).
156156

157157
* Some MATLAB commands are currently not supported in notebooks. These include:
158158

@@ -167,15 +167,15 @@ A reference architecture that installs `jupyter-matlab-proxy` in a Docker image
167167
* **For MATLAB R2022a and earlier,** `LASTERR` and `LASTERROR` do not capture MATLAB errors from execution in notebooks.
168168

169169
* Notebook results are truncated when there are more than 10 rows or 30 columns of results from MATLAB. This is represented by a `(...)` at the end of the result. Example:
170-
|![truncation-issue](img/truncation-issue.png)|
170+
|![truncation-issue](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/truncation-issue.png)|
171171
|-|
172172

173173
* Handles from Graphics objects do not persist between cells. For Example:
174-
|![invalid-handle](img/invalid-handle.png)|
174+
|![invalid-handle](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/invalid-handle.png)|
175175
|-|
176176

177177
* Graphics functions like `gca, gcf, gco, gcbo, gcbf, clf, cla` which access `current` handles are **scoped to a notebook cell**. The following example illustrates this:
178-
|![gca-issue](img/gca-issue.png)|
178+
|![gca-issue](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/gca-issue.png)|
179179
|-|
180180

181181
* Notebooks do not show intermediate figures that were created during execution.
@@ -187,7 +187,7 @@ A reference architecture that installs `jupyter-matlab-proxy` in a Docker image
187187
* Locally licensed MATLABs are currently not supported. Users must either login using Online Licensing or a Network License Manager.
188188

189189
## Troubleshooting
190-
See [Troubleshooting](./troubleshooting.md) for guidance on how to investigate common installation issues.
190+
See [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/troubleshooting.md) for guidance on how to investigate common installation issues.
191191

192192
## Feedback
193193

anaconda/parse_meta_file.py

Lines changed: 0 additions & 117 deletions
This file was deleted.

src/jupyter_matlab_kernel/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Click on `MATLAB Kernel` to create a Jupyter notebook for MATLAB.
1414

1515
## Architecture
1616

17-
|![kernelArchitecture](../../img/kernel-architecture.png)|
17+
|![kernelArchitecture](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/kernel-architecture.png)|
1818
|-|
1919

2020
**Key takeaways:**
@@ -46,10 +46,10 @@ Click on `MATLAB Kernel` to create a Jupyter notebook for MATLAB.
4646
* Inline static plot images
4747
* LaTeX representation for symbolic expressions
4848
* **For MATLAB R2022b and later:** Local functions can be defined at the end of a cell for use in the same cell
49-
![cellLocalFunctions](../../img/cell-local-function.png)
49+
![cellLocalFunctions](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/cell-local-function.png)
5050

5151
## Limitations
52-
Please refer to this [README](../../README.md#limitations) file for a listing of the current limitations.
52+
Please refer to this [README](https://github.com/mathworks/jupyter-matlab-proxy#limitations) file for a listing of the current limitations.
5353

5454
## Feedback
5555

src/jupyter_matlab_labextension/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This JupyterLab Labextension provides features to aid working
44
with MATLAB code in Jupyter. It is provided as
5-
part of [MATLAB Integration for Jupyter](../../README.md).
5+
part of [MATLAB Integration for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy#matlab-integration-for-jupyter).
66

77
## Supported Features
88
* Syntax highlighting

src/jupyter_matlab_proxy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This functionality requires the following packages:
88
| [matlab-proxy](https://github.com/mathworks/matlab-proxy) | Provides infrastructure to launch MATLAB and connect to it from a web browser.|
99
| [jupyter-server-proxy](https://github.com/jupyterhub/jupyter-server-proxy) | Extends Jupyter environments to launch MATLAB as an external process alongside the notebook server. For more information see [GUI Launchers](https://jupyter-server-proxy.readthedocs.io/en/latest/launchers.html#jupyterlab-launcher-extension).|
1010

11-
To report any issues or suggestions, see the [Feedback](#feedback) section.
11+
To report any issues or suggestions, see the [Feedback](https://github.com/mathworks/jupyter-matlab-proxy#feedback) section.
1212

1313
----
1414
## Usage
@@ -19,7 +19,7 @@ To report any issues or suggestions, see the [Feedback](#feedback) section.
1919
|--|--|
2020
|<p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/classic-jupyter.png"></p> | <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyterlab-notebook-section.png"></p> |
2121

22-
* To enter your license information, see [Licensing](../../README.md#licensing).
22+
* To enter your license information, see [Licensing](https://github.com/mathworks/jupyter-matlab-proxy#licensing).
2323

2424
* Wait for the MATLAB session to start. This can take several minutes.
2525

0 commit comments

Comments
 (0)