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.2.1.tar.gz
(158.8 kB
view hashes)
Close
Hashes for sphinxcontrib.asciinema-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f02e663977077c9fb72685e12d15bf145c41e1b6f411c34354bed2460f19aa9a |
|
MD5 | 45d579aa36f2f19ec8c3a420a2037ec4 |
|
BLAKE2b-256 | 623de744273b35ad4377649451c1bbf6f6ab10fecbfbb4e6316683a61fee58e5 |