Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

{Docs} Documentation update for debugging this repository using VS Code #14559

Merged
merged 20 commits into from
Oct 14, 2020
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
00b9235
{Docs} Remove stale reference in README to closed issue about extensi…
dkmiller Apr 27, 2020
ab16df0
Merge remote-tracking branch 'upstream/release'
azclibot Apr 28, 2020
03436bc
Merge remote-tracking branch 'upstream/release'
azclibot Apr 30, 2020
7d98b1f
Merge remote-tracking branch 'upstream/release'
azclibot May 19, 2020
06f6ec5
Merge remote-tracking branch 'upstream/release'
azclibot Jun 2, 2020
adab2d2
Merge remote-tracking branch 'upstream/release'
azclibot Jun 23, 2020
c7b9f98
Merge remote-tracking branch 'upstream/release'
azclibot Jul 14, 2020
18e8b8d
Merge remote-tracking branch 'upstream/release'
azclibot Jul 16, 2020
977fb9e
Merge remote-tracking branch 'upstream/dev' into dev
Jul 29, 2020
2f6c3c6
{Docs} Documentation update for debugging this repository using VS Co…
Jul 29, 2020
83aa4af
Merge latest changes from branch azure-cli dev branch into forked dev…
Aug 12, 2020
e9ddfa1
Merge branch dev from updated fork into niswitzeVSCodeDevelopmentDocs
Aug 12, 2020
bdd6945
{Docs} Documentation update for debugging this repository using VS Co…
Aug 12, 2020
51bf936
Update launch.json
fengzhou-msft Sep 15, 2020
3a46a4b
Update doc/configuring_your_machine.md
fengzhou-msft Sep 15, 2020
4fd98ff
Update doc/configuring_your_machine.md
fengzhou-msft Oct 13, 2020
82827f5
Update doc/configuring_your_machine.md
fengzhou-msft Oct 13, 2020
d955563
Update configuring_your_machine.md
fengzhou-msft Oct 13, 2020
fa7ada6
Update configuring_your_machine.md
fengzhou-msft Oct 13, 2020
7c70081
Update configuring_your_machine.md
fengzhou-msft Oct 13, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"name": "Azure CLI Debug (Integrated Console)",
"type": "python",
"request": "launch",
"pythonPath": "${config:python.pythonPath}",
"pythonPath": "${command:python.interpreterPath}",
"program": "${workspaceRoot}/src/azure-cli/azure/cli/__main__.py",
"cwd": "${workspaceRoot}",
"args": [
Expand All @@ -24,7 +24,7 @@
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "${config:python.pythonPath}",
"pythonPath": "${command:python.interpreterPath}",
"program": "${workspaceRoot}/src/azure-cli/azure/cli/__main__.py",
"cwd": "${workspaceRoot}",
"args": [
Expand All @@ -40,7 +40,7 @@
"name": "Azdev Scripts",
"type": "python",
"request": "launch",
"pythonPath": "${config:python.pythonPath}",
"pythonPath": "${command:python.interpreterPath}",
"program": "${workspaceRoot}/tools/automation/__main__.py",
"cwd": "${workspaceRoot}",
"args": [
Expand Down
8 changes: 2 additions & 6 deletions doc/configuring_your_machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,8 @@ The Azure Python CLI projects sources are located on GitHub (https://github.com/
4. Open the folder containing the clone of this repository in VS Code
5. Set the [Python Interpreter](https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment) to use as the python.exe located in your virtual environment
- If your virtual environment's Python Interpreter is not shown, you may need to add the root folder it's located in to the extension's venv path. This will be under File -> Preferences -> Settings -> Python: Venv Path.
- You can also create a settings.json file under the .vscode folder and specify the interpreter's path similar to the JSON below
```
{
"python.pythonPath": "C:\\repo\\env\\Scripts\\python.exe"
}
```
Comment on lines -49 to -53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can add the example back?

- You can also use your workspace or use settings.json, or launch.json file to specify the interpreter's path. This approach is detailed in the Environments section of the Python VS Code extension [documentation](https://code.visualstudio.com/docs/python/environments#_choose-a-debugging-environment).
fengzhou-msft marked this conversation as resolved.
Show resolved Hide resolved

6. Activate your environment and execute the following commands
1. pip install azdev
2. azdev setup -c
Expand Down