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.

Source Distribution

sphinxcontrib.asciinema-0.1.8.tar.gz (158.3 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib.asciinema-0.1.8.tar.gz.

File metadata

  • Download URL: sphinxcontrib.asciinema-0.1.8.tar.gz
  • Upload date:
  • Size: 158.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for sphinxcontrib.asciinema-0.1.8.tar.gz
Algorithm Hash digest
SHA256 48a5e15a41b3a4f098b3101fbadeafc96c3da759dff6d9dfc8895fa6c74a1796
MD5 df8a0a250596f8364391ef3f9e2a8c97
BLAKE2b-256 65a38766340c0271f04d230277a8375d6c1084e000730d0738f019f889c6336d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page