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 asciinema Player Options.
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinxcontrib_asciinema-0.4.3.tar.gz.
File metadata
- Download URL: sphinxcontrib_asciinema-0.4.3.tar.gz
- Upload date:
- Size: 74.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aeb480e33b3ac75edec76b8ad705487c4dff978e523a0143cc3962944dbd5d52
|
|
| MD5 |
9aaab4e39ec493905c2a4cc17b6d7ff2
|
|
| BLAKE2b-256 |
312361585345d0ad185acbd9d150d899a67d2f933c4e908c1df61a25f371e669
|
