summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-16 14:18:24 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-16 16:57:17 +0200
commita57fb82fb40b6f38f156bab1b06aa30a833c6046 (patch)
treee6f4a3a07a4db6dc298a27528ae15a60b96ec76f
parentf66cb54211d0880decc30f8fdcf18a571d765aef (diff)
downloadpylint-git-a57fb82fb40b6f38f156bab1b06aa30a833c6046.tar.gz
[doc] Remove our own pycharm section
-rw-r--r--doc/user_guide/ide_integration/ide-integration.rst1
-rw-r--r--doc/user_guide/ide_integration/pylint-pycharm.rst47
-rw-r--r--doc/user_guide/installation.rst3
3 files changed, 2 insertions, 49 deletions
diff --git a/doc/user_guide/ide_integration/ide-integration.rst b/doc/user_guide/ide_integration/ide-integration.rst
index 59198e61e..dea1106d0 100644
--- a/doc/user_guide/ide_integration/ide-integration.rst
+++ b/doc/user_guide/ide_integration/ide-integration.rst
@@ -8,5 +8,4 @@ Pylint can be integrated in various editors and IDE's. Below you can find tutori
:titlesonly:
flymake-emacs.rst
- pylint-pycharm.rst
textmate.rst
diff --git a/doc/user_guide/ide_integration/pylint-pycharm.rst b/doc/user_guide/ide_integration/pylint-pycharm.rst
deleted file mode 100644
index 6380da9b4..000000000
--- a/doc/user_guide/ide_integration/pylint-pycharm.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-.. _pylint_in_pycharm:
-
-Integrate Pylint with 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*.
diff --git a/doc/user_guide/installation.rst b/doc/user_guide/installation.rst
index cd4884a5b..066cfe822 100644
--- a/doc/user_guide/installation.rst
+++ b/doc/user_guide/installation.rst
@@ -50,7 +50,7 @@ Editor integration
- :ref:`Flymake <pylint_in_flymake>`
- `Jupyter Notebook`_
- Komodo_
-- :ref:`PyCharm <pylint_in_pycharm>`
+- `Pycharm`_
- PyDev_
- pyscripter_ in the `Tool -> Tools` menu.
- Spyder_ in the `View -> Panes -> Static code analysis`
@@ -68,6 +68,7 @@ Editor integration
.. _another option for gedit: https://wiki.gnome.org/Apps/Gedit/PylintPlugin
.. _Jupyter Notebook: https://github.com/nbQA-dev/nbQA
.. _Komodo: https://mateusz.loskot.net/post/2006/01/15/running-pylint-from-komodo/
+.. _Pycharm: https://stackoverflow.com/a/46409649/2519059
.. _pydev: https://www.pydev.org/manual_adv_pylint.html
.. _pyscripter: https://github.com/pyscripter/pyscripter
.. _spyder: https://docs.spyder-ide.org/current/panes/pylint.html