Skip to main content

A lightweight and modern animated terminal window for Sphinx

Project description

Sphinx Termynal

PyPI - Version Test Status codecov Doc Build Status

Animation1

Create animated terminal window in your Sphinx documentation.

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:

Animation1

Credits

Thanks ines, termynal.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_termynal-0.2.0.tar.gz (217.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_termynal-0.2.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_termynal-0.2.0.tar.gz.

File metadata

  • Download URL: sphinx_termynal-0.2.0.tar.gz
  • Upload date:
  • Size: 217.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for sphinx_termynal-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9262345f22913a48d648f2c78f50ded6e1b275139af5459fb5df525d05450126
MD5 cd97d6169fcb05fbef1ed5be462deb52
BLAKE2b-256 182632155aec353a9d057d7fa5792a1edb1eeabe69dc365b27c85b804edfe671

See more details on using hashes here.

File details

Details for the file sphinx_termynal-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_termynal-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3fc1dadf666f67c6544b61c977bd24e96ae77d93022faf2598b4e0d5657e37e
MD5 177f8ca88122b318b865958a38d977da
BLAKE2b-256 17c3e75cb49a5a21268dfef882be1ee85f500b4109c1c3b9d690aa12ba204b0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page