Sphinx extension debugging demo

by webknjaz 3 years ago

GNU/Linux ◆ xterm-kitty ◆ zsh 153 views

This recording shows the use of pdb, ipdb and pudb with a Sphinx extension that resides right in conf.py. It also shows how to use breakpoint().

Important things to remember:

Always clear the cache before attempting to rebuild the docs, otherwise, your code may end up not being called at all.
Force Sphinx to use a single process. If you allow parallelism, you’ll have trouble getting your debugger to work because subprocesses are not connected to your terminal.
This method should work with any debugger you may have integrated.

More by webknjaz

Demo of a dynamic var name in shell 00:37

by webknjaz 4 years ago

Demo of PYTHONBREAKPOINT=pudb.set_trace 02:44

by webknjaz 4 years ago

How relative import works in Python 00:55

by webknjaz 4 years ago

Get the current module entrypoint name in Python 05:44

by webknjaz 4 years ago

See all

You can download this recording in asciicast v2 format, as a .cast file.

Download

Replay in terminal

You can replay the downloaded recording in your terminal using the asciinema play command:

asciinema play 363733.cast

If you don't have asciinema CLI installed then see installation instructions.

Use with stand-alone player on your website

Download asciinema player from the releases page (you only need .js and .css file), then use it like this:

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" type="text/css" href="asciinema-player.css" />
</head>
<body>
  <div id="player"></div>
  <script src="asciinema-player.min.js"></script>
  <script>
    AsciinemaPlayer.create(
      '/assets/363733.cast',
      document.getElementById('player'),
      { cols: 78, rows: 20 }
    );
  </script>
</body>
</html>

See asciinema player quick-start guide for full usage instructions.

While this site doesn't offer GIF conversion at the moment, you can still do it yourself with the help of asciinema GIF generator utility - agg.

Once you have it installed run the following command to create GIF file:

agg https://asciinema.org/a/363733 363733.gif

Or, if you already downloaded the recording file:

agg 363733.cast 363733.gif

Check agg --help for all available options. You can change font family and size, select color theme, adjust speed and more.

See agg manual for full usage instructions.