Skip to main content

Animated terminal window for Sphinx

Project description


Sphinx Termynal

PyPI - Version Test Status codecov Doc Build Status

Documentation: https://prajeesh-ag.com/sphinx-termynal


Animation1

Create animated terminal window in your Sphinx documentation.

Installation

pip install sphinx-termynal

Usage

  1. Add the extension to conf.py:

    extensions = [
        ...
        "sphinx_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

For more examples check the Documentation

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.1.tar.gz (218.2 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.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_termynal-0.2.1.tar.gz
  • Upload date:
  • Size: 218.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sphinx_termynal-0.2.1.tar.gz
Algorithm Hash digest
SHA256 78a851543380523ed55c7a6ac286726138a8809bbcbcd14dfdd145f5823343ad
MD5 1016333fd14720ff313b2fe7a156b9aa
BLAKE2b-256 a3d4db7a6591297ae62f8684fe6b2e371590e0aa8ecf6e03e07cc7901e47a29a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_termynal-0.2.1.tar.gz:

Publisher: publish.yml on prajeeshag/sphinx-termynal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for sphinx_termynal-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2145797098888bd2c5c9e28ef39cb778643d69617528b5893eea8b5bae4376e6
MD5 791db5cc98a7718f770861c8747262a5
BLAKE2b-256 5846bf4897d0b36f22bb2c73d1038ce801b32d3420a0d8a622dfd2385f48eab6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_termynal-0.2.1-py3-none-any.whl:

Publisher: publish.yml on prajeeshag/sphinx-termynal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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