From 0f7ad9e37bc48d820f8c34e599b7cadf6b489911 Mon Sep 17 00:00:00 2001 From: Elliot Oram <elliot.oram@stfc.ac.uk> Date: Mon, 13 Aug 2018 14:10:55 +0100 Subject: [PATCH] Add pycharm plugin documentation --- dev-docs/source/GettingStartedWithPyCharm.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/dev-docs/source/GettingStartedWithPyCharm.rst b/dev-docs/source/GettingStartedWithPyCharm.rst index 58aa3852d64..8d138d26e53 100644 --- a/dev-docs/source/GettingStartedWithPyCharm.rst +++ b/dev-docs/source/GettingStartedWithPyCharm.rst @@ -103,3 +103,18 @@ On Linux the instructions are identical to Windows except that : - In step 1, the file is ``pycharm.sh`` rather than ``pycharm.bat`` - In step 2, use the native python interpreter (``/usr/bin/python2.7/python.exe``) rather than from ``<Mantid Source Directory>/external/src/ThirdParty/lib/python2.7/python.exe`` - In step 4, add ``<Mantid Build Directory>/bin;`` to the ``PATH`` environment variable in the new configuration (rather than ``<Mantid Build Directory>/bin/Debug;``), and remove the other three file paths. + +Useful Plugins +############## + +You can install non-default plugins by pressing ``Ctrl+Alt+S`` to open the **Settings/Preferences** dialog and then going to **Plugins**. +From here you can manage plugins, or add new ones by clicking **Browse repositories**. + +The following non-default plugins are things our team has found useful for Mantid development: + +- **Markdown support** - Side by side rendering of markdown documents such as``.md`` , ``.rst`` (requires `Graphviz <https://graphviz.gitlab.io/download/>`_ to show graphs in preview) +- **dotplugin** - Syntax highlighting for ``DOT`` +- **BashSupport** - Syntax highlighting for ``BASH`` scripts +- **CMD Support** - Syntax highlighting for ``.BAT`` ~scripts + +Please add to this list if you find a useful plugin of your own -- GitLab