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.9.tar.gz
(158.3 kB
view hashes)
Built Distribution
Close
Hashes for sphinxcontrib.asciinema-0.1.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 498dcbe76328dfac570719acb75b31ea093240adceeaa605e748360a29ac08e2 |
|
MD5 | 3c3cfa341bb364acbe1c02f4deaaea95 |
|
BLAKE2b-256 | 2431c19a324842693d86fa3fb0203852d75a96f97c56b745b57b5f128c9688ef |
Close
Hashes for sphinxcontrib.asciinema-0.1.9-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | f633a15ffa04b011429c6273ee9a3463b8fd7b6c44b8d01490154dd03d15966f |
|
MD5 | ef27b0d927d5befbd1fbc823b1db2af6 |
|
BLAKE2b-256 | 695e320a4b57d3a098752f6ba01eeaa425ad37731452a1ef12f1e47f35a71cc0 |