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
Release history Release notifications | RSS feed
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.7.tar.gz
(157.8 kB
view hashes)
Close
Hashes for sphinxcontrib.asciinema-0.1.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26739cff9d405a5657a42d8b1ad984c2ea091f1f573c23dc3f8e103d21d2ae1a |
|
MD5 | 38a169de98477f1e16e692294c12379f |
|
BLAKE2b-256 | 38c9b3cc70e94e9591f47fe3b64cc6dfc2a30e3041eab2917c8b63ee160d5167 |