Skip to content

tbielawa/sphinxcontrib-showterm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image

showterm

A Sphinx extension to embed termshows from showterm.io into your Sphinx documentation.

What?

This extension embeds an iframe in your generated documentation which plays back a terminal capture (i.e., everything visually that happened in a command line shell). Terminal captures are created with the showterm utility and are uploaded to showterm.io:

Usage is very simple. Once you've uploaded a termshow, copy the termshow ID from the URL and paste it into the .. showterm:: directive:

.. showterm:: 7b5f8d42ba021511e627e

The showterm extension allows you to specify a private showterm server, termshow width and height, and default playback speed (stop, slow, fast) with the following option flags:

.. showterm:: 7b5f8d42ba021511e627e
   :showtermurl: https://utils.example.com/showterm/
   :width: 1080px
   :height: 720px
   :speed: fast

Examples/Documentation

Please visit us on readthedocs for full documentation, usage examples, and extra configuration options.

About

An showterm.io extension for sphinx to embed termshows in your documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published