Skip to main content

embedding asciinema videos in Sphinx docs

Project description

sphinxcontrib-asciinema


Easily embed asciinema videos into Sphinx rst docs.

Installation

pip3 install sphinxcontrib.asciinema

Usage

Append extension to sphinx conf.py:

extensions = ['sphinxcontrib.asciinema']

Insert videos into rst docs:

.. asciinema:: 261648

or

.. asciinema:: https://asciinema.org/a/26148

(replace "261648" with your video id)

Enjoy!

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