Skip to content

Commit

Permalink
add vscode mentions
Browse files Browse the repository at this point in the history
Signed-off-by: Nok Lam Chan <[email protected]>
  • Loading branch information
noklam committed May 28, 2024
1 parent 56f2095 commit 121f899
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/development/set_up_vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ At this stage, you should be able to see the `conda` environment that you have c

![](../meta/images/vscode_setup_interpreter.png)

## Kedro VSCode Extension

Check warning on line 13 in docs/source/development/set_up_vscode.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/development/set_up_vscode.md#L13

[Kedro.headings] 'Kedro VSCode Extension' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Kedro VSCode Extension' should use sentence-style capitalization.", "location": {"path": "docs/source/development/set_up_vscode.md", "range": {"start": {"line": 13, "column": 4}}}, "severity": "WARNING"}
[Kedro VSCode extension](https://marketplace.visualstudio.com/items?itemName=kedro.Kedro) support 0.19+ versions of Kedro project. It supports features like go-to definition, find references and hovers etc.

Check warning on line 14 in docs/source/development/set_up_vscode.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/development/set_up_vscode.md#L14

[Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.
Raw output
{"message": "[Kedro.abbreviations] Use 'and more' instead of abbreviations like 'etc.'.", "location": {"path": "docs/source/development/set_up_vscode.md", "range": {"start": {"line": 14, "column": 203}}}, "severity": "WARNING"}

## Advanced: For those using `venv` / `virtualenv`

We're going to show you how to get your virtual environments to show up in your Python interpreter in VS Code. You do this by opening [`settings.json`](https://code.visualstudio.com/docs/getstarted/settings#_settings-file-locations) and adding the following:
Expand Down
4 changes: 4 additions & 0 deletions docs/source/get_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@ To exit `kedro-environment`:
```bash
conda deactivate
```
### Optional: Setup Kedro with IDE

Check warning on line 83 in docs/source/get_started/install.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/get_started/install.md#L83

[Kedro.headings] 'Optional: Setup Kedro with IDE' should use sentence-style capitalization.
Raw output
{"message": "[Kedro.headings] 'Optional: Setup Kedro with IDE' should use sentence-style capitalization.", "location": {"path": "docs/source/get_started/install.md", "range": {"start": {"line": 83, "column": 5}}}, "severity": "WARNING"}
Working in IDEs can be a great productivity boost.

For VS Code Users: Checkout [Set up Visual Studio Code](../development/set_up_vscode.md) and [Kedro VSCode Extension](../development/set_up_vscode.md#kedro-vscode-extension)
For PyCharm Users: Checkout [Set up PyCharm](../development/set_up_pycharm.md)

## How to install Kedro using `pip`

Expand Down

0 comments on commit 121f899

Please sign in to comment.