Skip to content

Commit c062ddb

Browse files
committed
Add instructions for getting code completion in PyCharm
1 parent 2ebc686 commit c062ddb

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed
12.4 KB
Loading
79.5 KB
Loading
42.8 KB
Loading

programming/editors/pycharm.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
layout: page
3+
title: PyCharm
4+
---
5+
6+
# PyCharm Setup
7+
8+
<div class="info">
9+
These instructions should also apply to IntelliJ IDEA with the Python plugin installed although the location of Python SDK settings will be different.
10+
</div>
11+
12+
In order to take full advantage of PyCharm's smart assistance features, such as code completion, PyCharm needs to have access to the libraries used in your code.
13+
The following instructions will guide you through setting up your local environment to have access our `sr.robot3` API.
14+
15+
1. Open your robot code project in PyCharm.
16+
2. Head to `File` &rarr; `Settings` or `PyCharm` &rarr; `Preferences` on a Mac.
17+
![Location of Settings menu option in PyCharm for Windows and Linux]({{ site.baseurl }}/images/content/programming/pycharm_app_menu.png)
18+
3. Select `Project` &rarr; `Project Interpreter` from the list on the left.
19+
4. Click the `+` symbol at the top of the packages list to install a new library.
20+
![PyCharm Interpreter Settings dialog]({{ site.baseurl }}/images/content/programming/pycharm_interpreter_settings.png)
21+
5. Search for `sr.robot3` then click `Install Package`
22+
![Installing sr.robot3 package from within PyCharm]({{ site.baseurl }}/images/content/programming/pycharm_pkgs.png)
23+
If this results in an error, try selecting the `Install to user's site packages directory` checkbox at the bottom of the dialog and try again.
24+
6. All done. You can now close the Settings window.
25+
26+
You should now be able to use code completion and have quick access documentation by pressing <kbd>Ctrl</kbd><kbd>Q</kbd> (or <kbd>⌃</kbd><kbd>J</kbd> on a Mac)

0 commit comments

Comments
 (0)