aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2022-01-06 11:40:56 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-01-06 13:56:40 +0000
commit4bb3abd257fceca2a638d4d5099d02b7162d747f (patch)
treee1ec547ae33b9145e1cb969e23ae74175548c3d4
parentff6f53bd00d0bc00232fe439b5ae0d94f53eee1a (diff)
Fix some doc warnings in the debugging tutorial
Fix: - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:2: WARNING: Title underline too short. - sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst:21: WARNING: Inline interpreted text or phrase reference start-string without end-string. Change the syntax highlighting to javascript, since json does not like the embedded comments of the MS-extended jsonc, fixing: sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:21: WARNING: Could not lex literal_block as "json". Highlighting skipped. sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst:47: WARNING: Could not lex literal_block as "json". Highlighting skipped. Amends d727a69e2f58be167845b8179edf1735df6ccf1e. Task-number: PYSIDE-841 Change-Id: I171c57e4a7f787559022fbbb14a7eb7bb9f1a91c Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> (cherry picked from commit 4a8b8e3dc45f1067a7f75e5f7ce95d8e639d530a) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst4
-rw-r--r--sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst4
2 files changed, 4 insertions, 4 deletions
diff --git a/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst b/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst
index 06783e1bb..c8c9fb8ae 100644
--- a/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst
+++ b/sources/pyside6/doc/tutorials/debugging/qtcreator/qtcreator.rst
@@ -1,5 +1,5 @@
Debugging PySide with Qt Creator (Linux)
-***************************************
+****************************************
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
@@ -18,7 +18,7 @@ Here are the steps:
:alt: creation of custom executable
:align: center
-3. Click on Custom Executable and `Create' a new configuration. Feed in the
+3. Click on Custom Executable and `Create` a new configuration. Feed in the
details like shown below.
.. image:: custom_executable_run_config.png
diff --git a/sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst b/sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst
index 59579e7cf..2563b4377 100644
--- a/sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst
+++ b/sources/pyside6/doc/tutorials/debugging/vscode/vscode.rst
@@ -18,7 +18,7 @@ Run -> Add Configuration -> Python -> Python File
This should create a launch.json file which looks like this:
-.. code-block:: json
+.. code-block:: javascript
{
// Use IntelliSense to learn about possible attributes.
@@ -44,7 +44,7 @@ interpreter inside the virtual environment.
Now, we need to add a configuration to attach the GDB debugger to the Python
process that is already running in debug mode. Let's call it "(gdb) Attach"
-.. code-block:: json
+.. code-block:: javascript
{
// Use IntelliSense to learn about possible attributes.