Skip to main content

Embed asciinema casts in your Sphinx docs

Project description


Easily embed asciinema videos into Sphinx rst docs.


Clone and cd into this repository, then:

pip install .

or install from PyPI:

pip install sphinxcontrib.asciinema


Append extension to sphinx

extensions = ['sphinxcontrib.asciinema']

Insert videos into .rst docs by embedding them from

.. asciinema:: 261648

or for a local file with a self-hosted web player:

.. asciinema:: local_file.cast

It is possible to give options as well:

.. asciinema:: local_file.cast
   :preload: 1
   :theme: solarized-dark

You can enter all options from the self-hosted player and the embedded player.

Default options can be set in

sphinxcontrib_asciinema_defaults = {
    'theme': 'solarized-dark',
    'preload': 1,
    'font-size': '15px',
#    'path': 'path/to/castdir'

The "path" option can be specified to set the default cast file directory. If a local file path starts with "./", the option is ignored.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib.asciinema, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib.asciinema-0.3.2.tar.gz (158.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page