summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-16 13:15:44 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-16 16:57:17 +0200
commit30f04779e3c749d7237f462296b9627852a91aaa (patch)
tree98a669a446111e1fd7de48de4a603fbcef36fa19
parentc106b5430aac6c36b77f9556bcea3ad670a27fe2 (diff)
downloadpylint-git-30f04779e3c749d7237f462296b9627852a91aaa.tar.gz
[doc] Link to internal document if they exists
-rw-r--r--doc/user_guide/ide_integration/flymake-emacs.rst10
-rw-r--r--doc/user_guide/ide_integration/pylint-pycharm.rst4
-rw-r--r--doc/user_guide/ide_integration/textmate.rst4
-rw-r--r--doc/user_guide/ide_integration/visual-studio-code.rst7
-rw-r--r--doc/user_guide/installation.rst13
5 files changed, 25 insertions, 13 deletions
diff --git a/doc/user_guide/ide_integration/flymake-emacs.rst b/doc/user_guide/ide_integration/flymake-emacs.rst
index 91e77bd04..44b9b3262 100644
--- a/doc/user_guide/ide_integration/flymake-emacs.rst
+++ b/doc/user_guide/ide_integration/flymake-emacs.rst
@@ -1,6 +1,16 @@
+.. _pylint_in_flymake:
+
Using Pylint through Flymake in Emacs
=====================================
+.. warning::
+ If you're reading this doc and are actually using flymake please
+ open a support question at https://github.com/PyCQA/pylint/issues/new/choose
+ and tell us, we don't have any maintainers for emacs and are thinking about
+ dropping the support.
+
+.. TODO 3.0, do we still need to support flymake ?
+
To enable Flymake for Python, insert the following into your .emacs:
.. sourcecode:: common-lisp
diff --git a/doc/user_guide/ide_integration/pylint-pycharm.rst b/doc/user_guide/ide_integration/pylint-pycharm.rst
index 46f837229..6380da9b4 100644
--- a/doc/user_guide/ide_integration/pylint-pycharm.rst
+++ b/doc/user_guide/ide_integration/pylint-pycharm.rst
@@ -1,8 +1,8 @@
+.. _pylint_in_pycharm:
+
Integrate Pylint with PyCharm
=============================
-.. _pylint_in_pycharm:
-
Install Pylint the usual way::
pip install pylint
diff --git a/doc/user_guide/ide_integration/textmate.rst b/doc/user_guide/ide_integration/textmate.rst
index c59d498fc..3486db340 100644
--- a/doc/user_guide/ide_integration/textmate.rst
+++ b/doc/user_guide/ide_integration/textmate.rst
@@ -1,8 +1,8 @@
+.. _pylint_in_textmate:
+
Integrate Pylint with TextMate
==============================
-.. _pylint_in_textmate:
-
Install Pylint in the usual way::
pip install pylint
diff --git a/doc/user_guide/ide_integration/visual-studio-code.rst b/doc/user_guide/ide_integration/visual-studio-code.rst
index 98baad4ce..a7ea7bf7d 100644
--- a/doc/user_guide/ide_integration/visual-studio-code.rst
+++ b/doc/user_guide/ide_integration/visual-studio-code.rst
@@ -1,6 +1,13 @@
+.. _visual-studio-code:
+
Integrate Pylint with Visual Studio Code
========================================
+See external documentation:
+
+- Linting python: https://code.visualstudio.com/docs/python/linting
+- Pylint Extension: https://marketplace.visualstudio.com/items?itemName=ms-python.pylint
+
Command-line arguments and configuration files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/user_guide/installation.rst b/doc/user_guide/installation.rst
index 1d3ac175b..5997ff8e1 100644
--- a/doc/user_guide/installation.rst
+++ b/doc/user_guide/installation.rst
@@ -50,14 +50,13 @@ Editor integration
- :ref:`Flymake <pylint_in_flymake>`
- `Jupyter Notebook`_
- Komodo_
-- PyCharm_ :ref:`the section below <pylint_in_pycharm>`
+- :ref:`PyCharm <pylint_in_pycharm>`
- PyDev_
- pyscripter_ in the `Tool -> Tools` menu.
- Spyder_ in the `View -> Panes -> Static code analysis`
-- TextMate_ :ref:`the section below <pylint_in_textmate>`
+- :ref:`TextMate <pylint_in_textmate>`
- Vim_
-- `Visual Studio`_
-- `Visual Studio Code`_ in the `Preferences -> Settings` menu (`Visual Studio Code Pylint Extension`_)
+- :ref:`Visual Studio Code <visual-studio-code>` in the `Preferences -> Settings` menu
- `Visual Studio`_ in the `Python > Run PyLint` command on a project's context menu.
- WingIDE_
@@ -68,13 +67,9 @@ 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://www.jetbrains.com/pycharm/
-.. _pydev: https://www.pydev.org/
+.. _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
-.. _TextMate: https://macromates.com
.. _Vim: https://www.vim.org/scripts/script.php?script_id=891
-.. _Visual Studio Code: https://code.visualstudio.com/docs/python/linting
-.. _Visual Studio Code Pylint Extension: https://marketplace.visualstudio.com/items?itemName=ms-python.pylint
.. _Visual Studio: https://docs.microsoft.com/visualstudio/python/code-pylint
.. _WingIDE: https://wingware.com/doc/warnings/external-checkers