Skip to main content

embedding asciinema videos in Sphinx docs

Project description

sphinxcontrib-asciinema

Easily embed asciinema videos into Sphinx rst docs.

Installation

Clone and cd into this repository, then:

pip install .

or install from PyPI:

pip install sphinxcontrib.asciinema

Usage

Append extension to sphinx conf.py:

extensions = ['sphinxcontrib.asciinema']

Insert videos into .rst docs by embedding them from asciinema.org:

.. 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 asciinema.org player.

Default options can be set in conf.py:

sphinxcontrib_asciinema_defaults = {
    'theme': 'solarized-dark',
    'preload': 1,
    'font-size': '15px'
}

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.1.10
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib.asciinema-0.1.10.tar.gz (158.4 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