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.5.1.tar.gz (18.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_vhs-1.5.1-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_vhs-1.5.1.tar.gz
  • Upload date:
  • Size: 18.2 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.5.1.tar.gz
Algorithm Hash digest
SHA256 e04b91f607128ac4eae6c06597e08189b8318984ecb1605ec3fb020dc6819375
MD5 bb108b3870065740baaf6cf11ca3019f
BLAKE2b-256 b64f9e811870023e0c214f13d4b23a30f65b4f9fa833c65afd7f50b05f8f0d99

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_vhs-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 8.5 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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15f9ba0b2359e6b8d0c86639e7e0920dd2f05a05920ed5f0af87b7e0d82d307c
MD5 af281cdd736046ef88bbf90601a1e257
BLAKE2b-256 030ffb6448673d74990ac176d6b518b3518d6ceb4b42b0206be59c1ffb416c0f

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