feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Restructure info about build and run configurations

Browse Source 
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
This commit is contained in:
Leena Miettinen
2023-11-06 18:22:45 +01:00
parent f7b1eed0c2
commit f708e200f9
48 changed files with 573 additions and 376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreator/src/python/creator-python-development.qdoc
View File

@@ -23,8 +23,8 @@
\li \l{Create a virtual environment}
\li \l{Use Python interactive shell}
\li \l{Python Language Server}
\li \l{Running Python projects}
\li \l{Specifying Run Settings for Python Projects}
\li \l{Run Python applications}
\li \l{Python Run Settings}
\li \l{PDB}
\li \l{Launching the Debugger}
\endlist

79
doc/qtcreator/src/python/creator-python-run-settings.qdoc Normal file
View File

@@ -0,0 +1,79 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-run-python-apps.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects
\ingroup creator-how-to-run
\title Run Python applications
You can execute Qt for Python applications directly from \QC. If you
use the new project wizard to create the application project, the
\c main.py file is automatically executed when you select the
\uicontrol Run button.
You can specify another file to execute in the run settings of the project.
\sa {Configure projects for running}, {Create Qt for Python applications},
{Develop Qt for Python applications}, {Python Run Settings}
*/
/*!
\page creator-run-settings-python.html
\previouspage creator-reference.html
\ingroup creator-reference-run-configurations
\title Python Run Settings
\brief Settings for running Qt for Python applications.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
\image qtcreator-python-run-settings.png {Python run settings}
The following table summarizes the settings for running Qt for Python
applications.
\table
\header
\li Setting
\li Value
\row
\li \uicontrol Interpreter
\li Path to the Python executable.
\row
\li \uicontrol {Buffered output}
\li Stores the output in a buffer. This improves output performance,
but causes delays in output.
\row
\li \uicontrol Script
\li Shows the path to the main file of the project that will be run.
\row
\li \uicontrol {Command line arguments}
\li Command-line arguments to pass to the executable.
\endtable
\section1 Custom Executable Run Configuration
To run some other Python file than \c main.py, create a custom
executable run configuration:
\image qtcreator-python-run-settings-custom-executable.png {Python custom executable run configuration}
\list 1
\li Select \uicontrol Add > \uicontrol {Custom Executable}.
\li In the \uicontrol Executable field, specify the path to the
Python executable.
\li In the \uicontrol {Command line arguments} field, select
the Python file to run.
\endlist
\sa {Activate kits for a project}, {Configure projects for running},
{Create Qt for Python applications}, {Develop Qt for Python applications}
*/

54
doc/qtcreator/src/python/creator-python-run.qdocinc
View File

@@ -1,54 +0,0 @@
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [running python]
\section1 Running Python Projects
You can execute Qt for Python applications directly from \QC. If you
used the \l{Use project wizards}{new project wizard}
to create the application project, the \c main.py file is automatically
executed when you select the \uicontrol Run button.
You can specify another file to execute in the
\l{Specifying Run Settings for Python Projects}{run settings}
of the project.
//! [running python]
//! [run settings python]
\section1 Specifying Run Settings for Python Projects
You can specify settings for running Qt for Python applications:
\image qtcreator-python-run-settings.png {Python run settings}
\list
\li In the \uicontrol Interpreter field, specify the path to the
Python executable.
\li Select the \uicontrol {Buffered output} check box to buffer the
output. This improves output performance, but causes delays in
output.
\li In the \uicontrol Script field, you can see the path to the
main file of the project that will be run.
\li In the \uicontrol {Command line arguments} field, specify
command-line arguments to be passed to the executable.
\endlist
If you want to run some other Python file than \c main.py, create a custom
executable run configuration:
\image qtcreator-python-run-settings-custom-executable.png
\list 1
\li Select \uicontrol Add > \uicontrol {Custom Executable}.
\li In the \uicontrol Executable field, specify the path to the
Python executable.
\li In the \uicontrol {Command line arguments} field, select
the Python file to run.
\endlist
//! [run settings python]
*/