sphinx-termynal 0.1.0

A lightweight and modern animated terminal window for Sphinx

Sphinx Termynal

A lightweight and modern animated terminal window. Built for sphinx.

Installation

pip install sphinx-termynal

Usage

1. Add the extension to conf.py:

   extensions = [
       ...
       'sphynx_termynal',
       ...
   ]
   

2. Use the extension in your documentation: You can now use it in your .rst files. For example:

.. termynal:: 
   $ pip install sphinx-termynal
   -->
   sphinx-termynal installed

This will produce the following terminal animation: