diff options
-rw-r--r-- | sources/pyside6/doc/commercial/index.rst | 8 | ||||
-rw-r--r-- | sources/pyside6/doc/developer/adapt_qt.rst | 4 | ||||
-rw-r--r-- | sources/pyside6/doc/developer/add_module.rst | 6 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/typesoffiles.rst | 8 | ||||
-rw-r--r-- | sources/pyside6/doc/faq/whichide.rst | 4 | ||||
-rw-r--r-- | sources/pyside6/doc/gettingstarted/index.rst | 18 | ||||
-rw-r--r-- | sources/pyside6/doc/tools/pyside-lrelease.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/tools/pyside-rcc.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/tools/pyside-uic.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/basictutorial/uifiles.rst | 4 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst | 6 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/debugging/qml_debugging.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst | 4 | ||||
-rw-r--r-- | sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst | 6 |
14 files changed, 38 insertions, 38 deletions
diff --git a/sources/pyside6/doc/commercial/index.rst b/sources/pyside6/doc/commercial/index.rst index 33c88cfec..e74419d6a 100644 --- a/sources/pyside6/doc/commercial/index.rst +++ b/sources/pyside6/doc/commercial/index.rst @@ -109,7 +109,7 @@ simplify the installation step:: Complementary to the wheels, you will be able to download the sources as well. -.. note:: Wheels installed this way will be detectable by `Qt Creator`_, which +.. note:: Wheels installed this way will be detectable by `*Qt Creator*`_, which will offer you to install them for your current Python interpreter. Using account.qt.io @@ -180,11 +180,11 @@ the wheels are:: Qt Creator Integration ---------------------- -Qt Creator offers the option to create new |project| projects from the main +*Qt Creator* offers the option to create new |project| projects from the main wizard. To execute the projects, make sure that the proper *Python Interpreter* is -selected, so Qt Creator can use the commercial modules you just installed. +selected, so *Qt Creator* can use the commercial modules you just installed. Go to *Edit -> Preferences* where you can find the *Python* option that will show the following: @@ -197,7 +197,7 @@ select the main Python executable from your environment. This can be found on ``path_to_your_env/bin/python`` (macOS and Linux), or ``path_to_your_env\python.exe`` (Windows). -As an alternative, you can launch Qt Creator from within the virtual +As an alternative, you can launch *Qt Creator* from within the virtual environment, detecting your installation automatically. Migrating from other versions diff --git a/sources/pyside6/doc/developer/adapt_qt.rst b/sources/pyside6/doc/developer/adapt_qt.rst index 68e8eab51..aec81fb0f 100644 --- a/sources/pyside6/doc/developer/adapt_qt.rst +++ b/sources/pyside6/doc/developer/adapt_qt.rst @@ -26,9 +26,9 @@ feature checks need to be added to ``CMakeList.txt`` (see for example The process consists of running a build and evaluating the log file. The script `shiboken2tasks.py <https://code.qt.io/cgit/qt-creator/qt-creator.git/tree/scripts/shiboken2tasks.py>`_ -from the Qt Creator repository can be used to convert the shiboken warnings +from the *Qt Creator* repository can be used to convert the shiboken warnings into a `task file <https://doc.qt.io/qtcreator/creator-task-lists.html>`_ -for display in the build issues pane of Qt Creator. +for display in the build issues pane of *Qt Creator*. Warnings about new enumerations will be shown there; they should be added to type system file using a ``since`` attribute. diff --git a/sources/pyside6/doc/developer/add_module.rst b/sources/pyside6/doc/developer/add_module.rst index f75aa5489..2eb962207 100644 --- a/sources/pyside6/doc/developer/add_module.rst +++ b/sources/pyside6/doc/developer/add_module.rst @@ -18,7 +18,7 @@ Add bindings - Add it to ``build_scripts/wheel_files.py`` (plugins, translations). - Copy an existing module to ``sources/pyside6/PySide6/<name>``. - Adapt the ``typesystem.xml`` and ``CMakeList.txt`` (using for example - Qt Creator's case-preserving replace function). + *Qt Creator*'s case-preserving replace function). - Make sure the dependencies are correct. - Find the exported public classes, add them to the ``typesystem.xml`` file, checking whether they are ``value-type`` or ``object-type``. Add their enums @@ -33,8 +33,8 @@ Add bindings typically hidden behind a progress message. - A convenient way of doing this is using ``qt-creator/scripts/shiboken2tasks.py`` from the - `Qt Creator repository <https://code.qt.io/cgit/qt-creator/qt-creator.git>`_ - converting them to a ``.tasks`` file which can be loaded into Qt Creator's + `*Qt Creator* repository <https://code.qt.io/cgit/qt-creator/qt-creator.git>`_ + converting them to a ``.tasks`` file which can be loaded into *Qt Creator*'s issue pane. - Link errors may manifest when ``generate_pyi`` imports the module trying to create signatures. They indicate a missing source file entry diff --git a/sources/pyside6/doc/faq/typesoffiles.rst b/sources/pyside6/doc/faq/typesoffiles.rst index 08003f7f1..3155b24fc 100644 --- a/sources/pyside6/doc/faq/typesoffiles.rst +++ b/sources/pyside6/doc/faq/typesoffiles.rst @@ -97,8 +97,8 @@ the QML file, and optionally, elements defined in Python that are exposed to QML to be used. You can write ``.qml`` files by hand, but also you can use tools like the -QML Designer that is embedded in Qt Creator. Additionally, there are commercial -tools like Qt Design Studio that allow you to load designs from other design +*QML Designer* that is embedded in *Qt Creator*. Additionally, there are commercial +tools like *Qt Design Studio* that allow you to load designs from other design applications. Here you can find an example of how a ``.qml`` file looks like. @@ -128,11 +128,11 @@ message on it. Qt Creator Python Project File ``.pyproject`` --------------------------------------------- -For Qt Creator to load and handle Python based projects, a special file is +For *Qt Creator* to load and handle Python based projects, a special file is needed, because C++ based projects could be handle from ``.qmake`` or ``CMakeLists.txt`` file, which are not used with Python-based projects. -Old versions of Qt Creator, provided a simple format with the ``.pyqtc`` +Old versions of *Qt Creator*, provided a simple format with the ``.pyqtc`` extension, which were plain-text files with one-file-per-line:: library/server.py diff --git a/sources/pyside6/doc/faq/whichide.rst b/sources/pyside6/doc/faq/whichide.rst index 0eaba0c9e..3afa79b7f 100644 --- a/sources/pyside6/doc/faq/whichide.rst +++ b/sources/pyside6/doc/faq/whichide.rst @@ -4,7 +4,7 @@ Which IDEs Are Compatible? ========================== |project|, as any other Python module, can be used in any Python-compatible -IDE, but not all of them will provide extra functionality like Qt Creator does. +IDE, but not all of them will provide extra functionality like *Qt Creator* does. Besides writing files, there are some external steps you might want to perform in order to help the development of your applications: @@ -48,7 +48,7 @@ PyCharm ------- You can configure PyCharm to enable external tools, in |project| terms, -*Qt Widgets Designer*, and Qt Creator. Go to +*Qt Widgets Designer*, and *Qt Creator*. Go to ``File > Settings > tools > PyCharm External Tools``, and include the following information to add them to your project. Later, you will be able to right click a ``.ui`` file, and select diff --git a/sources/pyside6/doc/gettingstarted/index.rst b/sources/pyside6/doc/gettingstarted/index.rst index 14af0ec80..9d36061ad 100644 --- a/sources/pyside6/doc/gettingstarted/index.rst +++ b/sources/pyside6/doc/gettingstarted/index.rst @@ -476,9 +476,9 @@ to get the HTML files), you can go to the generated You can add ``-j X``, to perform the build process in parallel with X processes. -.. note:: The :command:`apidoc` make target builds offline documentation in ``QCH`` (Qt Creator Help) - format by default. You can switch to building for the online use with the ``--doc-build-online`` - configure option. +.. note:: The :command:`apidoc` make target builds offline documentation in ``QCH`` + (Qt Compressed Help) format by default. You can switch to building for the + online use with the ``--doc-build-online`` configure option. The target executes several steps: @@ -503,13 +503,13 @@ formatting, you can re-run ``sphinx`` in the ``doc`` directory:: Viewing offline documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The offline documentation (QCH) can be viewed using the Qt Creator IDE or Qt Assistant, which is -a standalone application for viewing QCH files. +The offline documentation (QCH) can be viewed using the *Qt Creator* IDE or +*Qt Assistant*, which is a standalone application for viewing QCH files. -To view the QCH using Qt Creator, following the instructions outlined in -`Using Qt Creator Help Mode <https://doc.qt.io/qtcreator/creator-help.html>`_. If you chose to -use Qt Assistant instead, use the following command to register the QCH file before launching -Qt Assistant:: +To view the QCH using *Qt Creator*, following the instructions outlined in +`Using Qt Creator Help Mode <https://doc.qt.io/qtcreator/creator-help.html>`_. +If you chose to use *Qt Assistant* instead, use the following command to register +the QCH file before launching *Qt Assistant*:: assistant -register PySide.qch diff --git a/sources/pyside6/doc/tools/pyside-lrelease.rst b/sources/pyside6/doc/tools/pyside-lrelease.rst index 43c239219..7c628f2aa 100644 --- a/sources/pyside6/doc/tools/pyside-lrelease.rst +++ b/sources/pyside6/doc/tools/pyside-lrelease.rst @@ -4,7 +4,7 @@ pyside6-lrelease ================ .. note:: This tool is automatically called by :ref:`pyside6-project` - so you don't need to call it manually. Qt Creator will take care + so you don't need to call it manually. *Qt Creator* will take care of this step as well while executing a project. ``pyside6-lrelease`` is a command line tool wrapping `lrelease`_. It produces diff --git a/sources/pyside6/doc/tools/pyside-rcc.rst b/sources/pyside6/doc/tools/pyside-rcc.rst index ee71500a7..e5688485e 100644 --- a/sources/pyside6/doc/tools/pyside-rcc.rst +++ b/sources/pyside6/doc/tools/pyside-rcc.rst @@ -4,7 +4,7 @@ pyside6-rcc =========== .. note:: This tool is automatically called by :ref:`pyside6-project` - so you don't need to call it manually. Qt Creator will take care + so you don't need to call it manually. *Qt Creator* will take care of this step as well while executing a project. diff --git a/sources/pyside6/doc/tools/pyside-uic.rst b/sources/pyside6/doc/tools/pyside-uic.rst index 3fe5d9ccc..ba4e36b4e 100644 --- a/sources/pyside6/doc/tools/pyside-uic.rst +++ b/sources/pyside6/doc/tools/pyside-uic.rst @@ -4,7 +4,7 @@ pyside6-uic =========== .. note:: This tool is automatically called by :ref:`pyside6-project` - so you don't need to call it manually. Qt Creator will take care + so you don't need to call it manually. *Qt Creator* will take care of this step as well while executing a project. ``pyside6-uic`` is a command line tool for converting ``.ui`` files into ``.py`` diff --git a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst index 1b313c3c3..cb945908d 100644 --- a/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst +++ b/sources/pyside6/doc/tutorials/basictutorial/uifiles.rst @@ -8,7 +8,7 @@ This page describes the use of graphical interfaces based on Qt Widgets for your Qt for Python project. *Qt Widgets Designer* is a graphical UI design tool which is available as a standalone binary (``pyside6-designer``) or embedded into the -`Qt Creator IDE <https://doc.qt.io/qtcreator>`_. Its use within **Qt Creator** +`Qt Creator IDE <https://doc.qt.io/qtcreator>`_. Its use within *Qt Creator* is described at `Using Qt Widgets Designer <https://doc.qt.io/qtcreator/creator-using-qt-designer.html>`_. @@ -19,7 +19,7 @@ The designs are stored in ``.ui`` files, which is an XML-based format. It will be converted to Python or C++ code populating a widget instance at project build time by the `pyside6-uic <https://doc.qt.io/qt-6/uic.html>`_ tool. -To create a new Qt Design Form in **Qt Creator**, choose +To create a new Qt Design Form in *Qt Creator*, choose ``File/New File Or Project`` and "Main Window" for template. Save it as ``mainwindow.ui``. Add a ``QPushButton`` to the center of the centralwidget. diff --git a/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst b/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst index d425b701f..85c326347 100644 --- a/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst +++ b/sources/pyside6/doc/tutorials/debugging/mixed_debugging.rst @@ -5,10 +5,10 @@ When debugging PySide code, very often you would also like to debug the corresponding C++ extension of the PySide module. This is done by attaching your debugger to the Python interpreter. In this tutorial, we are going to take you through a comprehensive guide in building Qt 6, using the built Qt 6 to build -PySide6, and then starting a debugging process in either Qt Creator or VSCode. +PySide6, and then starting a debugging process in either *Qt Creator* or VSCode. With VSCode, you should be able to see the combined call stacks for both C++ and -Python together. With Qt Creator, unfortunately you would only be able to +Python together. With *Qt Creator*, unfortunately you would only be able to debug the native C++ code of the PySide module; that is you won't be able to set breakpoints inside the Python code. @@ -116,7 +116,7 @@ It is recommended to use a Python virtual environment rather than installing in Debugging the process using your preferred IDE ---------------------------------------------- -The following sections guide you through the setup for Qt Creator or VSCode. +The following sections guide you through the setup for *Qt Creator* or VSCode. .. toctree:: :glob: diff --git a/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst b/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst index 474abe50b..223e608fc 100644 --- a/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst +++ b/sources/pyside6/doc/tutorials/debugging/qml_debugging.rst @@ -1,7 +1,7 @@ Using Qt Creator's QML Debugger for a PySide6 QML Application ************************************************************* -Besides the C++ debugger, Qt Creator provides a `QML debugger`_ which lets you +Besides the C++ debugger, *Qt Creator* provides a `QML debugger`_ which lets you inspect JavaScript code. It works by connecting to a socket server run by the ``QmlEngine`` instance. The port is passed on the command line. To enable it, add the below code to your QML application: diff --git a/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst b/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst index a35020fd1..a78a67fad 100644 --- a/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst +++ b/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst @@ -1,9 +1,9 @@ Debugging PySide with Qt Creator (Linux) **************************************** -As opposed to VSCode, presently Qt Creator does not support mixed mode debugging. +As opposed to VSCode, presently *Qt Creator* does not support mixed mode debugging. However, we can debug the C++ implementation of the corresponding Python PySide -code. Unlike VSCode, Qt Creator provides a very easy interface to attach GDB to +code. Unlike VSCode, *Qt Creator* provides a very easy interface to attach GDB to the Python interpreter. It saves you from doing all the extra configuration steps, that have to be done with VSCode. diff --git a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst index b77648d6a..c6d72e742 100644 --- a/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst +++ b/sources/pyside6/doc/tutorials/qmlapp/qmlapplication.rst @@ -15,15 +15,15 @@ defined in the QML file. Before you begin, install the following prerequisites: * The `PySide6 <https://pypi.org/project/PySide6/>`_ Python packages. -* Qt Creator v4.9 beta1 or later from +* *Qt Creator* from `https://download.qt.io <https://download.qt.io/snapshots/qtcreator/>`_. The following step-by-step instructions guide you through application -development process using Qt Creator: +development process using *Qt Creator*: -#. Open Qt Creator and select **File > New File or Project..** menu item +#. Open *Qt Creator* and select **File > New File or Project..** menu item to open following dialog: .. image:: newpyproject.png |