From cf6d7ff0357287ea33f92d7fa684f54388c79732 Mon Sep 17 00:00:00 2001 From: Shuguang Sun Date: Tue, 18 Jun 2024 18:04:50 +0800 Subject: [PATCH] chore(saspy): refactor doc as main branch Signed-off-by: Shuguang Sun --- .../Configurations/Profiles/additional.md | 14 ++++++++ .../docs/Configurations/Profiles/sas9py.md | 20 +++++++++++ website/docs/matrix.md | 34 +++++++++---------- 3 files changed, 51 insertions(+), 17 deletions(-) create mode 100644 website/docs/Configurations/Profiles/sas9py.md diff --git a/website/docs/Configurations/Profiles/additional.md b/website/docs/Configurations/Profiles/additional.md index ae342f992..1d9bbcf1c 100644 --- a/website/docs/Configurations/Profiles/additional.md +++ b/website/docs/Configurations/Profiles/additional.md @@ -65,6 +65,20 @@ SAS system options can be set for each connection profile. Changes to the SAS sy } ``` +- SAS 9.4 (SASPy): + + ```json + { + "profiles": { + "sas9SASPY": { + "cfgname": "winlocal", + "sasOptions": ["NONEWS", "ECHOAUTO", "PAGESIZE=MAX"], + "ConnectionType": "saspy" + } + } + } + ``` + ## SAS Autoexec Settings For SAS Viya connection profiles, you can set up autoexec code that executes each time you start a new session. Changes to the autoexec code do not take effect until you close and restart your SAS session. The Autoexec option supports different modes for how to define the SAS lines that should run: diff --git a/website/docs/Configurations/Profiles/sas9py.md b/website/docs/Configurations/Profiles/sas9py.md new file mode 100644 index 000000000..5d192b773 --- /dev/null +++ b/website/docs/Configurations/Profiles/sas9py.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 5 +--- + +# SAS 9.4 (SASPy) Connection Profile + +To use SAS 9.4 (SASPy) connection type, you need to have Python and [SASPy](https://sassoftware.github.io/saspy) installed locally (the machine VS Code is installed on) or remotely (if you are using VScode remote development). SASPy fully supports connection methods of STDIO (Unix only), SSH, IOM (Remote and Local) and HTTP, and partially supports connection method of COM. You can visit the following [link](https://sassoftware.github.io/saspy) to find out how to install SASPy and how to configure it. + + +## Profile Anatomy + +A SAS 9.4 (SASPy) connection profile includes the following parameters: + +`"connectionType": "saspy"` + +| Name | Description | Additional Notes | +| -------------- | -------------- | ----------------------------------------------------------------------------- | +| `pythonpath` | Path to python | Defaults to `python` | +| `cfgname` | sascfg name | Visit [link](sassoftware.github.io/saspy/configuration.html) for introduction | + diff --git a/website/docs/matrix.md b/website/docs/matrix.md index 0f3b2c2a8..4e1589df7 100644 --- a/website/docs/matrix.md +++ b/website/docs/matrix.md @@ -4,23 +4,23 @@ sidebar_position: 2 # Capabilities by Connection Type -| SAS Extension for Visual Studio Code - Capabilities by Connection Type | SAS Viya | SAS 9.4 (local)
SAS 9.4 (remote - IOM) | SAS 9.4 (remote - SSH) | Notes | -| --------------------------------------------------------------------------------------------- | :----------------: | :------------------------------------------: | :--------------------: | -------------------------------------------------------------------- | -| [SAS Options settings](./Configurations/Profiles/additional.md#sas-options-settings-examples) | :heavy_check_mark: | :heavy_check_mark:\* | :heavy_check_mark: | \*Startup options not supported for SAS 9.4 (local) and (remote-IOM) | -| [SAS Autoexec settings](./Configurations/Profiles/additional.md#sas-autoexec-settings) | :heavy_check_mark: | :x: | :x: | -| [Access SAS Content](./Features/accessContent.md) | :heavy_check_mark: | :x: | :x: | -| [Access connected libraries](./Features/accessLibraries.md) | :heavy_check_mark: | :heavy_check_mark: | :x: | -| [Table viewer](./Features/accessLibraries.md) | :heavy_check_mark: | :heavy_check_mark: | :x: | -| [SAS Notebooks](./Features/sasNotebook.md) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| Convert SAS Notebook to SAS Studio Flow | :heavy_check_mark: | :x: | :x: | -| [SAS syntax highlighting in SAS code](./Features/sasCodeEditing.md#sas-syntax-highlighting) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| SAS errors, warnings, and notes highlighting in SAS log | :heavy_check_mark: | :heavy_check_mark: | :x: | A SAS color theme is required. | -| Show problems from SAS log | :heavy_check_mark: | :heavy_check_mark: | :x: | -| [Code folding and code outline](./Features/sasCodeEditing.md#code-folding-and-code-outline) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| [Code completion](./Features/sasCodeEditing.md#code-completion) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| [Pop-up syntax help](./Features/sasCodeEditing.md#pop-up-syntax-help) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| [Snippets](./Features/sasCodeEditing.md#snippets) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -| Able to cancel a running program | :heavy_check_mark: | :heavy_check_mark: | :x: | +| SAS Extension for Visual Studio Code - Capabilities by Connection Type | SAS Viya | SAS 9.4 (local)
SAS 9.4 (remote - IOM) | SAS 9.4 (remote - SSH) | SAS 9.4 (remote - SSH) | Notes | +| --------------------------------------------------------------------------------------------- | :----------------: | :------------------------------------------: | :--------------------: | :---------------------: | -------------------------------------------------------------------- | +| [SAS Options settings](./Configurations/Profiles/additional.md#sas-options-settings-examples) | :heavy_check_mark: | :heavy_check_mark:\* | :heavy_check_mark: | :heavy_check_mark:\* | \*Startup options not supported for SAS 9.4 (local) and (remote-IOM) | +| [SAS Autoexec settings](./Configurations/Profiles/additional.md#sas-autoexec-settings) | :heavy_check_mark: | :x: | :x: | :x: | | +| [Access SAS Content](./Features/accessContent.md) | :heavy_check_mark: | :x: | :x: | :x: | | +| [Access connected libraries](./Features/accessLibraries.md) | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | | +| [Table viewer](./Features/accessLibraries.md) | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | | +| [SAS Notebooks](./Features/sasNotebook.md) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| Convert SAS Notebook to SAS Studio Flow | :heavy_check_mark: | :x: | :x: | | | +| [SAS syntax highlighting in SAS code](./Features/sasCodeEditing.md#sas-syntax-highlighting) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| SAS errors, warnings, and notes highlighting in SAS log | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | A SAS color theme is required. | +| Show problems from SAS log | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | | +| [Code folding and code outline](./Features/sasCodeEditing.md#code-folding-and-code-outline) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| [Code completion](./Features/sasCodeEditing.md#code-completion) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| [Pop-up syntax help](./Features/sasCodeEditing.md#pop-up-syntax-help) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| [Snippets](./Features/sasCodeEditing.md#snippets) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | +| Able to cancel a running program | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | | # Choose Connection Type