[doc] Better more useful links for ide integration

Author: Pierre-Sassoulas

doc/conf.py

@@ -54,6 +54,7 @@
     # "<source>": "<target>"
     "intro": "index.html",
     "support": "contact.html",
+    "ide-integration": "installation.html",
 }
 
 # Add any paths that contain templates here, relative to this directory.

doc/faq.rst

@@ -82,11 +82,6 @@ For example::
 
     pylint --disable=bare-except,invalid-name --class-rgx='[A-Z][a-z]+' --generate-toml-config
 
-3.4 I'd rather not run Pylint from the command line. Can I integrate it with my editor?
----------------------------------------------------------------------------------------
-
-Much probably. Read :ref:`user_guide/installation:ide-integration`
-
 3.5 I need to run pylint over all modules and packages in my project directory.
 -------------------------------------------------------------------------------
 

doc/user_guide/ide-integration.rst

@@ -0,0 +1,70 @@
+Using Pylint through Flymake in Emacs
+=====================================
+
+To enable Flymake for Python, insert the following into your .emacs:
+
+.. sourcecode:: common-lisp
+
+    ;; Configure Flymake for Python
+    (when (load "flymake" t)
+      (defun flymake-pylint-init ()
+        (let* ((temp-file (flymake-init-create-temp-buffer-copy
+                           'flymake-create-temp-inplace))
+               (local-file (file-relative-name
+                            temp-file
+                            (file-name-directory buffer-file-name))))
+          (list "epylint" (list local-file))))
+      (add-to-list 'flymake-allowed-file-name-masks
+                   '("\\.py\\'" flymake-pylint-init)))
+
+    ;; Set as a minor mode for Python
+    (add-hook 'python-mode-hook '(lambda () (flymake-mode)))
+
+Above stuff is in ``pylint/elisp/pylint-flymake.el``, which should be automatically
+installed on Debian systems, in which cases you don't have to put it in your ``.emacs`` file.
+
+Other things you may find useful to set:
+
+.. sourcecode:: common-lisp
+
+    ;; Configure to wait a bit longer after edits before starting
+    (setq-default flymake-no-changes-timeout '3)
+
+    ;; Keymaps to navigate to the errors
+    (add-hook 'python-mode-hook '(lambda () (define-key python-mode-map "\C-cn" 'flymake-goto-next-error)))
+    (add-hook 'python-mode-hook '(lambda () (define-key python-mode-map "\C-cp" 'flymake-goto-prev-error)))
+
+
+Finally, by default Flymake only displays the extra information about the error when you
+hover the mouse over the highlighted line. The following will use the minibuffer to display
+messages when you the cursor is on the line.
+
+.. sourcecode:: common-lisp
+
+    ;; To avoid having to mouse hover for the error message, these functions make Flymake error messages
+    ;; appear in the minibuffer
+    (defun show-fly-err-at-point ()
+      "If the cursor is sitting on a Flymake error, display the message in the minibuffer"
+      (require 'cl)
+      (interactive)
+      (let ((line-no (line-number-at-pos)))
+        (dolist (elem flymake-err-info)
+          (if (eq (car elem) line-no)
+    	  (let ((err (car (second elem))))
+    	    (message "%s" (flymake-ler-text err)))))))
+
+    (add-hook 'post-command-hook 'show-fly-err-at-point)
+
+
+Alternative, if you only wish to pollute the minibuffer after an explicit flymake-goto-* then use
+the following instead of a post-command-hook
+
+.. sourcecode:: common-lisp
+
+    (defadvice flymake-goto-next-error (after display-message activate compile)
+      "Display the error in the mini-buffer rather than having to mouse over it"
+      (show-fly-err-at-point))
+
+    (defadvice flymake-goto-prev-error (after display-message activate compile)
+      "Display the error in the mini-buffer rather than having to mouse over it"
+      (show-fly-err-at-point))

doc/user_guide/ide_integration/flymake-emacs.rst

@@ -0,0 +1,12 @@
+###########################
+ Editor and IDE integration
+###########################
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   flymake-emacs.rst
+   pylint-pycharm.rst
+   textmate.rst
+   visual-studio-code.rst

doc/user_guide/ide_integration/ide-integration.rst

@@ -0,0 +1,47 @@
+Integrate Pylint with PyCharm
+=============================
+
+.. _pylint_in_pycharm:
+
+Install Pylint the usual way::
+
+    pip install pylint
+
+Remember the path at which it's installed::
+
+    which pylint
+
+Using pylint-pycharm plugin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#.  In PyCharm go to *Preferences* > *Plugins* > *Browse repositories...*
+#.  Right-click on the plugin named **Pylint**, select **Download and Install** and restart PyCharm when prompted
+
+If the plugin is not finding the Pylint executable (e.g. is not inside the PATH environmental variable), you can
+specify it manually using the plugin settings:
+
+#.  *Preferences* > *Other Settings* > *Pylint* or simply click the gear icon from the side bar of the Pylint tool window
+#.  Type the path directly or use the Browse button to open a file selection dialog
+#.  Press the Test button to check if the plugin is able to run the executable
+
+For more info on how to use the plugin please check the `official plugin documentation <https://github.com/leinardi/pylint-pycharm/blob/master/README.md>`_.
+
+Using External Tools
+~~~~~~~~~~~~~~~~~~~~
+
+Within PyCharm:
+
+#.  Navigate to the preferences window
+#.  Select "External Tools"
+#.  Click the plus sign at the bottom of the dialog to add a new external task
+#.  In the dialog, populate the following fields:
+
+    :Name:                              Pylint
+    :Description:                       A Python source code analyzer which looks for programming errors, helps enforcing a coding standard and sniffs for some code smells.
+    :Synchronize files after execution: unchecked
+    :Program:                           ``/path/to/pylint``
+    :Parameters:                        ``$FilePath$``
+
+#.  Click OK
+
+The option to check the current file with Pylint should now be available in *Tools* > *External Tools* > *Pylint*.