Skip to main content

Sphinx plugin that generates terminal GIFs using charm's VHS

Project description

Sphinx VHS

Sphinx-VHS is an integration plugin for Sphinx and VHS, a tool by charm that renders terminal commands into GIFs. It allows referencing .tape files form your docs, and rendering them during sphinx build.

Resources

Requirements

  • python >= 3.11
  • sphinx >= 8.0

Installation

pip install sphinx-vhs

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_vhs-1.4.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

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

sphinx_vhs-1.4.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_vhs-1.4.0.tar.gz.

File metadata

  • Download URL: sphinx_vhs-1.4.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_vhs-1.4.0.tar.gz
Algorithm Hash digest
SHA256 7d11b4fcfd453fc3a532b8f622dbdefd28b88e6e727bd4e5714b5919f09af30d
MD5 7f31120f92d1c2df21b7ee7b65785293
BLAKE2b-256 a7b5ce20d3e76c2ee9e07f00d287f3e4d4a879c53ecb7a3351108c061c547f2b

See more details on using hashes here.

File details

Details for the file sphinx_vhs-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_vhs-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_vhs-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8239b7637d7de80b63ce22faeb73d635bffe267e46553862eb1e4ecb59aece9
MD5 39b136968d8267ba7c042cf5bd0bc809
BLAKE2b-256 f018d75ed0fc7799754a55308f86f95148358fe3a9afb3405adf0607cde8cb36

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