Move language-specific debugging docs to the page for each language (#33692)

Release Notes:

- N/A
This commit is contained in:
Cole Miller 2025-07-01 16:02:12 -04:00 committed by GitHub
parent 0e2e5b8b0d
commit b7bfdd3383
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 411 additions and 345 deletions

View file

@ -6,6 +6,7 @@ Python support is available natively in Zed.
- Language Servers:
- [microsoft/pyright](https://github.com/microsoft/pyright)
- [python-lsp/python-lsp-server](https://github.com/python-lsp/python-lsp-server) (PyLSP)
- Debug Adapter: [debugpy](https://github.com/microsoft/debugpy)
## Language Servers
@ -125,3 +126,67 @@ A common tool for formatting Python code is [Ruff](https://docs.astral.sh/ruff/)
TBD: Expand Python Ruff docs.
TBD: Ruff pyproject.toml, ruff.toml docs. `ruff.configuration`.
-->
## Debugging
Zed supports zero-configuration debugging of Python module entry points and pytest tests.
Run {#action debugger::Start} ({#kb debugger::Start}) to see a contextual list for the current project.
For greater control, you can add debug configurations to `.zed/debug.json`. See the examples below.
### Debug Active File
```json
[
{
"label": "Python Active File",
"adapter": "Debugpy",
"program": "$ZED_FILE",
"request": "launch"
}
]
```
### Flask App
For a common Flask Application with a file structure similar to the following:
```
.venv/
app/
init.py
main.py
routes.py
templates/
index.html
static/
style.css
requirements.txt
```
…the following configuration can be used:
```json
[
{
"label": "Python: Flask",
"adapter": "Debugpy",
"request": "launch",
"module": "app",
"cwd": "$ZED_WORKTREE_ROOT",
"env": {
"FLASK_APP": "app",
"FLASK_DEBUG": "1"
},
"args": [
"run",
"--reload", // Enables Flask reloader that watches for file changes
"--debugger" // Enables Flask debugger
],
"autoReload": {
"enable": true
},
"jinja": true,
"justMyCode": true
}
]
```