Build Sphinx documentation with Docker

Link

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

Embed image link

Use snippets below to display a screenshot linking to this recording.
Useful in places where scripts are not allowed (e.g. in a project's README file).

HTML:

Markdown:

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:

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

See embedding docs for additional options.

You can download this recording in asciicast v1 format, as a .json file.

Download

Replay in terminal

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

asciinema play 26498.json

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/26498.json',
      document.getElementById('player'),
      { cols: 85, rows: 28 }
    );
  </script>
</body>
</html>

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

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/26498 demo.gif

Or, if you already downloaded the recording file:

agg demo.cast demo.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.

Build Sphinx documentation with Docker

More by OrangeTux

Build image from Dockerfile 00:06

Copy data from Docker container to host using mounted volume. 00:16

Configuring Buildroot 00:54

A running Docker container 00:10