Sphinx extension debugging demo

by webknjaz
Download
.cast - original recording .txt - plain text version .gif - animated GIF
GNU/Linux • xterm-kitty • zsh 376 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 recordings by webknjaz

Browse all

pypa/virtualenv#1688 fix demo 4:35

by webknjaz

Demo of a dynamic var name in shell 0:37

by webknjaz

Using patched cherry-picker to backport a PR in ansible/ansible 0:27

by webknjaz

How relative import works in Python 0:55

by webknjaz
Share this recording
https://asciinema.org/a/363733
Copied!

Append ?t=30 to start the playback at 30s, ?t=3:20 to start the playback at 3m 20s.

See sharing docs for more link customization options.

Embed as image link

Use snippets below to display a preview image linking to this recording.
Ideal for places where scripts are not allowed, such as project README files.

HTML: 

<a href="https://asciinema.org/a/363733" target="_blank"><img src="https://asciinema.org/a/363733.svg" /></a>
Copied!

Markdown: 

[![asciicast](https://asciinema.org/a/363733.svg)](https://asciinema.org/a/363733)
Copied!

Embed the player

If you're embedding on your own page or on a site which permits script tags, you can use the full player widget:

<script src="https://asciinema.org/a/363733.js" id="asciicast-363733" async="true"></script>
Copied!

Paste the above script tag where you want the player to be displayed on your page.

See embedding docs for more player customization options.

Download this recording

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
Copied!

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="/assets/asciinema-player.css" />
</head>
<body>
  <div id="player"></div>
  <script src="/assets/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.

Generate GIF from this recording

While this site doesn't provide 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, generate a GIF with the following command:

agg https://asciinema.org/a/363733 demo.gif
Copied!

Or, if you already downloaded the recording file:

agg demo.cast demo.gif
Copied!

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.