Skip to content

Commit c3b7379

Browse files
Automated documentation update [skip ci] (#2)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent fd631be commit c3b7379

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

src/matlab/README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# MATLAB (matlab)
23

34
Installs MATLAB with supporting packages and tools.
@@ -12,26 +13,28 @@ Installs MATLAB with supporting packages and tools.
1213

1314
## Options
1415

15-
| Options Id | Description | Type | Default Value |
16-
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------------------- |
17-
| release | MATLAB Release to install. | string | r2024b |
18-
| products | Products to install, specified as a list of space-separated product names.</br> For details of products, see [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md#product-installation-options). | string | MATLAB |
19-
| doc | Flag to install documentation and examples (R2022b and earlier releases). | boolean | false |
20-
| installGpu | Skips installation of GPU libraries when you install Parallel Computing Toolbox (R2023a and later releases). | boolean | false |
21-
| destination | Full path to the installation destination folder. | string | /opt/matlab/$RELEASE |
22-
| installMatlabProxy | Installs matlab-proxy and its dependencies (R2020b and later releases). | boolean | false |
23-
| installJupyterMatlabProxy | Installs jupyter-matlab-proxy and its dependencies (R2020b and later releases). | boolean | false |
24-
| installMatlabEngineForPython | Installs the MATLAB Engine for Python if the destination option is set correctly. | boolean | false |
25-
| startInDesktop | Starts matlab-proxy when container starts. | string | false |
26-
| networkLicenseManager | MATLAB will use the specified Network License Manager. | string | - |
27-
| skipMATLABInstall | Set to true if you do not want to install MATLAB, for example if you only want to install `matlab-proxy` or `jupyter-matlab-proxy`. | boolean | false |
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| release | MATLAB Release to install. | string | R2024b |
19+
| products | Products to install, specified as a list of space-separated product names.</br> For details of products, see [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md#product-installation-options). | string | MATLAB |
20+
| doc | Flag to install documentation and examples (R2022b and earlier releases). | boolean | false |
21+
| installGpu | Skips installation of GPU libraries when you install Parallel Computing Toolbox (R2023a and later releases). | boolean | false |
22+
| destination | Full path to the installation destination folder. Default: /opt/matlab/${RELEASE^} | string | - |
23+
| installMatlabProxy | Installs matlab-proxy and its dependencies (R2020b and later releases). | boolean | false |
24+
| installJupyterMatlabProxy | Installs jupyter-matlab-proxy and its dependencies (R2020b and later releases). | boolean | false |
25+
| installMatlabEngineForPython | Installs the MATLAB Engine for Python if the destination option is set correctly. | boolean | false |
26+
| startInDesktop | Starts matlab-proxy when container starts. | string | false |
27+
| networkLicenseManager | MATLAB will use the specified Network License Manager. | string | - |
28+
| skipMATLABInstall | Set to true if you do not want to install MATLAB, for example if you only want to install `matlab-proxy` or `jupyter-matlab-proxy`. | boolean | false |
2829

2930
## Customizations
3031

3132
### VS Code Extensions
3233

3334
- `MathWorks.language-matlab`
3435

36+
37+
3538
---
3639

37-
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/mathworks/devcontainer-features/blob/main/src/matlab/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
40+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/mathworks/devcontainer-features/blob/main/src/matlab/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)