Doc: Document new Python language server options

Task-number: QTCREATORBUG-27560
Change-Id: I659f9ef11b25363126ca387c2844bdddfa33f284
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Leena Miettinen
2022-06-09 17:07:23 +02:00
parent 750c50a00f
commit 2364761c8e
7 changed files with 40 additions and 22 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

After

Width:  |  Height:  |  Size: 6.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

@@ -50,8 +50,8 @@
architectures (ABIs) installed as one. architectures (ABIs) installed as one.
To enable helpful code editing features for Java, such as code completion, To enable helpful code editing features for Java, such as code completion,
highlighting, function tooltips, and navigating in code, specify settings highlighting, function tooltips, and navigating in code, add a
for a \l{Specifying Java Language Server Settings}{Java language server}. \l{Java Language Server}{Java language server}.
The Android Debug Bridge (adb) command line tool is integrated to \QC to The Android Debug Bridge (adb) command line tool is integrated to \QC to
enable you to deploy applications to connected Android devices, to run enable you to deploy applications to connected Android devices, to run

View File

@@ -79,33 +79,31 @@
\section1 Specifying Settings for Language Clients \section1 Specifying Settings for Language Clients
You can add a generic generic stdIO language server for Python, for example. \QC supports adding a Java language server for
For \l{Connecting Android Devices}{Android development}, you can add a Java \l{Connecting Android Devices}{Android development}. A Python language
language server. 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 add language servers, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Language Client} > \uicontrol Add (or \uicontrol {Qt Creator} >
To view a list of language servers, select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Language Client} > \uicontrol Add
\uicontrol Preferences > \uicontrol {Language Client} (or on \macos).
\uicontrol {Qt Creator} > \uicontrol Preferences >
\uicontrol {Language Client} > on \macos).
\image qtcreator-language-client-options.png "Language client options page"
To enable a language server, select the check box next to the language 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. 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: To add a generic language server:
\list 1 \list 1
\li Select \uicontrol Edit > \uicontrol Preferences > \li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Language Client} > \uicontrol Add > \uicontrol {Language Client} > \uicontrol Add >
\uicontrol {New Generic StdIO Language Server} \uicontrol {Generic StdIO Language Server}
to add a generic 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. \li In the \uicontrol Name field, enter a name for the language server.
Select the \inlineimage icons/replace.png Select the \inlineimage icons/replace.png
(\uicontrol {Variables}) button to use a variable for the server (\uicontrol {Variables}) button to use a variable for the server
@@ -119,8 +117,9 @@
with a matching MIME type is opened. \l{Viewing Output} with a matching MIME type is opened. \l{Viewing Output}
{General Messages} displays information about the connection to the {General Messages} displays information about the connection to the
language server. language server.
\li In the \uicontrol Initialization field, you can add language server \li In the \uicontrol {Initialization options} field, you can add
specific JSON attributes to pass to an \c initialize request. language server specific JSON attributes to pass to an \c initialize
request.
\li In the \uicontrol Executable field, enter the path to the language \li In the \uicontrol Executable field, enter the path to the language
server executable. server executable.
\li In the \uicontrol Arguments field, enter any required command line \li In the \uicontrol Arguments field, enter any required command line
@@ -128,15 +127,15 @@
arguments. arguments.
\endlist \endlist
\section2 Specifying Java Language Server Settings \section2 Java Language Server
To add a Java language server: To add a Java language server:
\list 1 \list 1
\li Select \uicontrol Edit > \uicontrol Preferences > \li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Language Client} > \uicontrol Add > \uicontrol {Language Client} > \uicontrol Add >
\uicontrol {New Java Language Server} to add a Java language server. \uicontrol {Java Language Server} to add a Java language server.
\image qtcreator-language-client-options-java.png "Java language server options" \image qtcreator-language-client-options-java.png "Java language server preferences"
\li In the \uicontrol Name field, enter a name for the language server. \li In the \uicontrol Name field, enter a name for the language server.
Select the \inlineimage icons/replace.png Select the \inlineimage icons/replace.png
(\uicontrol {Variables}) button to use a variable for the server (\uicontrol {Variables}) button to use a variable for the server
@@ -146,6 +145,25 @@
the Java language server \c .jar file. the Java language server \c .jar file.
\endlist \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 \section1 Supported Locator Filters
@@ -205,7 +223,7 @@
\section1 Reporting Issues \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 If problems arise when you try them or some other language, please select
\uicontrol Help > \uicontrol {Report Bug} to report them in the \uicontrol Help > \uicontrol {Report Bug} to report them in the
\l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports \l{https://bugreports.qt.io/}{Qt Project Bug Tracker}. The reports