diff --git a/doc/qtcreator/images/qtcreator-language-client-options-java.png b/doc/qtcreator/images/qtcreator-language-client-options-java.png index d70df4dd477..592d7d2f5a3 100644 Binary files a/doc/qtcreator/images/qtcreator-language-client-options-java.png and b/doc/qtcreator/images/qtcreator-language-client-options-java.png differ diff --git a/doc/qtcreator/images/qtcreator-language-client-options.png b/doc/qtcreator/images/qtcreator-language-client-options.png deleted file mode 100644 index 0ae18ec4e41..00000000000 Binary files a/doc/qtcreator/images/qtcreator-language-client-options.png and /dev/null differ diff --git a/doc/qtcreator/images/qtcreator-language-server-generic-stdio.png b/doc/qtcreator/images/qtcreator-language-server-generic-stdio.png new file mode 100644 index 00000000000..4c0b26b8b68 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-language-server-generic-stdio.png differ diff --git a/doc/qtcreator/images/qtcreator-python-advanced.png b/doc/qtcreator/images/qtcreator-python-advanced.png new file mode 100644 index 00000000000..eea49d610cf Binary files /dev/null and b/doc/qtcreator/images/qtcreator-python-advanced.png differ diff --git a/doc/qtcreator/images/qtcreator-python-plugins.png b/doc/qtcreator/images/qtcreator-python-plugins.png new file mode 100644 index 00000000000..c2ba0b05a17 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-python-plugins.png differ diff --git a/doc/qtcreator/src/android/androiddev.qdoc b/doc/qtcreator/src/android/androiddev.qdoc index 86797263481..bc736490c68 100644 --- a/doc/qtcreator/src/android/androiddev.qdoc +++ b/doc/qtcreator/src/android/androiddev.qdoc @@ -50,8 +50,8 @@ architectures (ABIs) installed as one. To enable helpful code editing features for Java, such as code completion, - highlighting, function tooltips, and navigating in code, specify settings - for a \l{Specifying Java Language Server Settings}{Java language server}. + highlighting, function tooltips, and navigating in code, add a + \l{Java Language Server}{Java language server}. The Android Debug Bridge (adb) command line tool is integrated to \QC to enable you to deploy applications to connected Android devices, to run diff --git a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc index 2786828c40e..384707adae4 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc @@ -79,33 +79,31 @@ \section1 Specifying Settings for Language Clients - You can add a generic generic stdIO language server for Python, for example. - For \l{Connecting Android Devices}{Android development}, you can add a Java - language server. + \QC supports adding a Java language server for + \l{Connecting Android Devices}{Android development}. A Python language + server is added by default and you can edit its preferences. + For other languages, you can add generic stdIO language servers. - \section2 Adding Language Servers - - To view a list of language servers, select \uicontrol Edit > - \uicontrol Preferences > \uicontrol {Language Client} (or - \uicontrol {Qt Creator} > \uicontrol Preferences > - \uicontrol {Language Client} > on \macos). - - \image qtcreator-language-client-options.png "Language client options page" + To add language servers, select \uicontrol Edit > \uicontrol Preferences > + \uicontrol {Language Client} > \uicontrol Add (or \uicontrol {Qt Creator} > + \uicontrol Preferences > \uicontrol {Language Client} > \uicontrol Add + on \macos). To enable a language server, select the check box next to the language - server name and specify settings for the server. + server name and set server preferences. To remove language servers from the list, select \uicontrol Delete. - \section2 Specifying Generic Settings + \section2 Generic StdIO Language Server To add a generic language server: \list 1 \li Select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Language Client} > \uicontrol Add > - \uicontrol {New Generic StdIO Language Server} + \uicontrol {Generic StdIO Language Server} to add a generic language server. + \image qtcreator-language-server-generic-stdio.png \li In the \uicontrol Name field, enter a name for the language server. Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button to use a variable for the server @@ -119,8 +117,9 @@ with a matching MIME type is opened. \l{Viewing Output} {General Messages} displays information about the connection to the language server. - \li In the \uicontrol Initialization field, you can add language server - specific JSON attributes to pass to an \c initialize request. + \li In the \uicontrol {Initialization options} field, you can add + language server specific JSON attributes to pass to an \c initialize + request. \li In the \uicontrol Executable field, enter the path to the language server executable. \li In the \uicontrol Arguments field, enter any required command line @@ -128,15 +127,15 @@ arguments. \endlist - \section2 Specifying Java Language Server Settings + \section2 Java Language Server To add a Java language server: \list 1 \li Select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Language Client} > \uicontrol Add > - \uicontrol {New Java Language Server} to add a Java language server. - \image qtcreator-language-client-options-java.png "Java language server options" + \uicontrol {Java Language Server} to add a Java language server. + \image qtcreator-language-client-options-java.png "Java language server preferences" \li In the \uicontrol Name field, enter a name for the language server. Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button to use a variable for the server @@ -146,6 +145,25 @@ the Java language server \c .jar file. \endlist + \section2 Python Language Server + + To set preferences for Python language servers: + + \list 1 + \li Select \uicontrol Edit > \uicontrol Preferences > + \uicontrol Python > \uicontrol {Language Server Configuration} to + select the Python language server plugins to use. + \image qtcreator-python-plugins.png "Python Language Server Configuration" + \li Select \uicontrol Advanced to configure the plugins. + \image qtcreator-python-advanced.png "Python language server plugin configuration" + \endlist + + For a complete list of configuration options, see + \l{https://github.com/python-lsp/python-lsp-server/blob/develop/CONFIGURATION.md} + {Python Language Server Configuration}. + + To disable the Python language server, deselect + \uicontrol {Use Python Language Server}. \section1 Supported Locator Filters @@ -205,7 +223,7 @@ \section1 Reporting Issues - The language service client has been mostly tested with Python and Java. + The language server client has been mostly tested with Python and Java. If problems arise when you try them or some other language, please select \uicontrol Help > \uicontrol {Report Bug} to report them in the \l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports