Merge pull request #292 from srobo/pycharm-instructions

Author: raccube

_data/sidebar_tree.yaml

@@ -66,8 +66,10 @@ tree:
     - url: /programming/editors/
       title: Code Editors
       tree:
+      - url: /programming/editors/pycharm
+        title: PyCharm
       - url: /programming/editors/vscode
-        title: VSCode
+        title: Visual Studio Code
   - url: /rules/
     title: Rules
     tree:

images/content/programming/pycharm_app_menu.png

@@ -0,0 +1,26 @@
+---
+layout: page
+title: PyCharm
+---
+
+# PyCharm Setup
+
+<div class="info">
+These instructions should also apply to IntelliJ IDEA with the Python plugin installed although the location of Python SDK settings will be different.
+</div>
+
+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.
+The following instructions will guide you through setting up your local environment to have access our `sr.robot3` API.
+
+1. Open your robot code project in PyCharm.
+2. Head to **File** &rarr; **Settings** or **PyCharm** &rarr; **Preferences** on a Mac.
+![Location of Settings menu option in PyCharm for Windows and Linux]({{ site.baseurl }}/images/content/programming/pycharm_app_menu.png)
+3. Select `Project` &rarr; `Python Interpreter` from the list on the left.
+4. Click the `+` symbol at the top of the packages list to install a new library.
+![PyCharm Interpreter Settings dialog]({{ site.baseurl }}/images/content/programming/pycharm_interpreter_settings.png)
+5. Search for `sr.robot3` then click `Install Package`
+![Installing sr.robot3 package from within PyCharm]({{ site.baseurl }}/images/content/programming/pycharm_pkgs.png)
+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.
+6. All done. You can now close the Settings window.
+
+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)

images/content/programming/pycharm_interpreter_settings.png

@@ -31,7 +31,7 @@ In order for VSCode to pick up the `sr.robot3` library and offer [completions][c
 you'll need to make the library available within the Python environment that you're using.
 
 1. Open the workspace containing your code.
-2. Open a terminal via **Terminal** > **New Terminal**.
+2. Open a terminal via **Terminal** → **New Terminal**.
 3. Run `pip install sr.robot3`.
 
 [code-completion]: https://en.wikipedia.org/wiki/Autocomplete#In_source_code_editors

images/content/programming/pycharm_pkgs.png

@@ -34,7 +34,7 @@ You may receive a warning about your computer's GPU not being good enough, which
 #### Changing your version of Python
 
 If webots is picking up the incorrect version of Python, you'll need to change it.
-This can be done using `Tools > Preferences > General > Python command` (or `Webots > Preferences` <kbd>⌘</kbd><kbd>,</kbd> on a Mac).
+This can be done using **Tools** &rarr; **Preferences** &rarr; **General** &rarr; **Python command** (or **Webots** &rarr; **Preferences** <kbd>⌘</kbd><kbd>,</kbd> on a Mac).
 You'll need to ensure a matching version of Python is installed. If you're still
 having problems, ask for help in [`#simulator-help`][simulator-help] in
 [Discord][discord].