Embed asciinema casts in your 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',
# '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
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.3.6.tar.gz
(158.6 kB
view hashes)
Close
Hashes for sphinxcontrib.asciinema-0.3.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad8a15cca90454bfb2bd8558500f518f11b3dbdc4e3cb79d03cea6195985c8ce |
|
MD5 | 74c476feda9c1db1ad0b16de65262e9b |
|
BLAKE2b-256 | 398e904302f223bbc6da3f08a753b1d858ff2d8484701be3eb31660001e271c8 |