Skip to content

Commit e2b8af9

Browse files
jayhackcodegen-bot
and
codegen-bot
authored
docs: fixes IDE installation instructions (#198)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed - [ ] I have read and agree to the [Contributor License Agreement](../CLA.md) --------- Co-authored-by: codegen-bot <[email protected]>
1 parent ded94b1 commit e2b8af9

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

docs/introduction/ide-usage.mdx

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ Codegen creates a custom Python environment in `.codegen/.venv`. Configure your
1515

1616
<AccordionGroup>
1717
<Accordion title="VSCode, Cursor and Windsurf" icon="window-maximize">
18-
1. Open the Command Palette (Cmd/Ctrl + Shift + P)
19-
2. Type "Python: Select Interpreter"
18+
1. Install the VSCode Python Extensions for LSP and debugging support. We recommend Python, Pylance and Python Debugger for the best experience.
19+
<img src="/images/python-extensions.png" />
20+
2. Open the Command Palette (Cmd/Ctrl + Shift + P)
21+
3. Type "Python: Select Interpreter"
2022
<img src="/images/set-interpreter.png" />
21-
3. Choose "Enter interpreter path"
22-
4. Navigate to and select:
23+
4. Choose "Enter interpreter path"
24+
5. Navigate to and select:
2325
```bash
2426
.codegen/.venv/bin/python
2527
```
@@ -29,13 +31,10 @@ Codegen creates a custom Python environment in `.codegen/.venv`. Configure your
2931
{
3032
"python.defaultInterpreterPath": "${workspaceFolder}/.codegen/.venv/bin/python",
3133
"python.analysis.extraPaths": [
32-
"${workspaceFolder}/.codegen/.venv/lib/python3.11/site-packages"
34+
"${workspaceFolder}/.codegen/.venv/lib/python3.12/site-packages"
3335
]
3436
}
3537
```
36-
37-
5. Install the VSCode Python Extensions for LSP and debugging support. We recommend Python, Pylance and Python Debugger for the best experience.
38-
<img src="/images/python-extensions.png" />
3938
</Accordion>
4039

4140
<Accordion title="PyCharm" icon="python">
@@ -47,24 +46,8 @@ Codegen creates a custom Python environment in `.codegen/.venv`. Configure your
4746
```bash
4847
.codegen/.venv/bin/python
4948
```
50-
51-
For better type hints:
52-
1. Right-click on `.codegen/.venv`
53-
2. Mark Directory as > Sources Root
54-
</Accordion>
55-
56-
<Accordion title="Troubleshooting" icon="wrench">
57-
Common issues and solutions:
58-
59-
- **Missing Completions**: Make sure the interpreter is correctly set and the environment has `codegen` installed
60-
- **Import Errors**: Verify the environment is activated and Python path includes the virtual environment
61-
- **Wrong Python Version**: Check that you're using Python 3.11 or higher in `.codegen/.venv`
62-
63-
Run this to verify your environment:
64-
```bash
65-
.codegen/.venv/bin/python -c "import codegen; print(codegen.__version__)"
66-
```
6749
</Accordion>
50+
6851
</AccordionGroup>
6952

7053

0 commit comments

Comments
 (0)