Skip to content

Commit 79991b0

Browse files
committed
Restore doc/panes/debugging.rst to use the old images for now
1 parent ca64c16 commit 79991b0

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

doc/panes/debugging.rst

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Debugger
55
**Debugging** in Spyder is supported through integration with the enhanced ``ipdb`` debugger in the :doc:`ipythonconsole`.
66
This allows breakpoints and the execution flow to be viewed and controlled right from the Spyder GUI, as well as with all the familiar IPython console commands.
77

8-
.. image:: /images/debugging/debugging-console.webp
8+
.. image:: /images/debugging/debugging-console.png
99
:alt: A Spyder IPython console window, showing the ipdb debugger in action
1010

1111

@@ -16,41 +16,35 @@ Debugging with ipdb
1616

1717
You can fully control debugger execution from the :guilabel:`Debug` menu, :guilabel:`Debug toolbar` and via configurable keyboard shortcuts, along with the standard ``ipdb`` `console commands`_.
1818

19-
.. video:: /images/debugging/debugging-commands.webm
19+
.. image:: /images/debugging/debugging-commands.gif
2020
:alt: A Spyder IPython console window, showing debugging from toolbar
21-
:loop:
22-
:align: center
2321

2422
Additionally, the :doc:`editor` shows the line of code the debugger is currently stopped on with an arrow.
2523

2624
.. _console commands: https://wangchuan.github.io/coding/2017/07/12/ipdb-cheat-sheet.html
2725

28-
.. image:: /images/debugging/debugging-arrow.webp
26+
.. image:: /images/debugging/debugging-arrow.png
2927
:alt: Spyder Editor showing the debugging panel
3028

3129
Spyder's debugger offers syntax highlighting, code completion and command history, which work exactly like they do in the normal interactive interpreter.
3230

3331
Use the up and down arrows to recall previous commands, and press :kbd:`Tab` to trigger autocomplete suggestions.
3432

35-
.. video:: /images/debugging/debugging-autocompletion.webm
33+
.. image:: /images/debugging/debugging-autocompletion.gif
3634
:alt: A Spyder IPython console window, showing autocompletion when debugging
37-
:loop:
38-
:align: center
3935

4036
Furthermore, IPython's `magic functions`_ are available in debugging mode.
4137
You can, for example, run ``%ls`` to list the contents of your current working directory or ``%timeit`` to check how fast a given snippet of code is.
4238

4339
.. _magic functions: https://ipython.readthedocs.io/en/stable/interactive/magics.html
4440

45-
.. image:: /images/debugging/debugging-timeit.webp
41+
.. image:: /images/debugging/debugging-timeit.png
4642
:alt: Ipython console in debug mode showing timeit magic
4743

4844
Finally, you can enter and execute multiline statements in Spyder's debugger just like with the regular IPython prompt, to easily run complex code.
4945

50-
.. video:: /images/debugging/debugging-multiline.webm
51-
:loop:
46+
.. image:: /images/debugging/debugging-multiline.gif
5247
:alt: Debugger showing multiline debugger
53-
:align: center
5448

5549

5650
.. _debugging-breakpoints:
@@ -62,7 +56,7 @@ Breakpoints
6256
Spyder's debugger is integrated with the :guilabel:`Breakpoints` pane, which lists the file, line, and condition (if any) of every breakpoint defined.
6357
To open it, select :menuselection:`Debug --> List breakpoints`, or press :kbd:`Ctrl-Shift-B` (:kbd:`Cmd-Shift-B` on macOS).
6458

65-
.. image:: /images/debugging/breakpoints-standard.webp
59+
.. image:: /images/debugging/breakpoints-standard.png
6660
:alt: Spyder's Breakpoints panel, with a number of examples showing file, line number and an optional condition
6761

6862
There are several different ways to set and clear breakpoints:
@@ -73,14 +67,12 @@ There are several different ways to set and clear breakpoints:
7367
* With the ``breakpoint()`` builtin function in your code.
7468
* Interactively, using the ``b`` command in a debugging session.
7569

76-
.. video:: /images/debugging/debugging-breakpoints.webm
70+
.. image:: /images/debugging/debugging-breakpoints.gif
7771
:alt: Spyder showing setting conditional breakpoint
78-
:loop:
79-
:align: center
8072

8173
You can access and edit local and global variables at each breakpoint through the :doc:`variableexplorer`.
8274

83-
.. image:: /images/debugging/debugging-variables.webp
75+
.. image:: /images/debugging/debugging-variables.png
8476
:alt: Spyder's console and variable explorer showing local and global variables when debugging
8577

8678

@@ -92,20 +84,20 @@ Advanced features
9284
You can avoid stepping through other Python packages while debugging by enabling the new :guilabel:`Ignore Python libraries while debugging` option in Spyder's preferences, under :menuselection:`IPython Console --> Debugger --> Debug`.
9385
This will skip all the built-in and third-party Python modules you have installed.
9486

95-
.. image:: /images/debugging/debugging-libraries.webp
87+
.. image:: /images/debugging/debugging-libraries.png
9688
:alt: Spyder's preferences showing Ignore Python libraries while debugging options
9789

9890
If your code has variables with the same names as Pdb commands (e.g. ``b`` or ``step``), you can still refer to them as normal while debugging.
9991
To call the respective Pdb command, just add an exclamation point before it (e.g. ``!b`` or ``!step``).
10092

101-
.. image:: /images/debugging/debugging-commands.webp
93+
.. image:: /images/debugging/debugging-commands.png
10294
:alt: Spyder's IPython console showing Pdb commands
10395

10496
You can have Spyder automatically execute a custom snippet of code every time the debugger stops.
10597
For example, you can use this to set specific variables, or import commonly-used modules so they are always available while debugging.
10698
To set this up, go to :menuselection:`Preferences --> IPython Console --> Debugger --> Run code while debugging`, and enter the code that you want to be executed with each step.
10799

108-
.. image:: /images/debugging/debugging-snippet.webp
100+
.. image:: /images/debugging/debugging-snippet.png
109101
:alt: Spyder's preferenes with debugging snippet
110102

111103

@@ -117,10 +109,8 @@ Matplotlib support
117109
Generating Matplotlib figures is fully supported while the debugger is active, including all the different graphics backends.
118110
Use the ``%matplotlib`` magic to change to an interactive backend (e.g. ``%matplotlib qt5``) to pan, zoom and adjust your plots in a separate window, or switch back to the default ``inline`` (``%matplotlib inline``) to see them displayed right in the :doc:`plots` pane.
119111

120-
.. video:: /images/debugging/debugging-matplotlib.webm
112+
.. image:: /images/debugging/debugging-matplotlib.gif
121113
:alt: Debugger showing matplotlib interactive backend
122-
:loop:
123-
:align: center
124114

125115

126116
To avoid showing plots while debugging, deactivate the :guilabel:`Process execute events while debugging` option in :menuselection:`Preferences --> IPython console --> Debugger`.

0 commit comments

Comments
 (0)