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.2.tar.gz (82.3 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.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_vhs-1.5.2.tar.gz
Algorithm Hash digest
SHA256 a0e27298e7ac8793ba7c3a8a16dc37c80c8e5000260d15a0e75ba1c734465d0f
MD5 807cf6daaa9f74b41869e95aa2ec7e50
BLAKE2b-256 5d1db1c198abc181d5ed99f56f39d7d9a3d8b34c283d88c22f395a7592933a4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_vhs-1.5.2-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.12

File hashes

Hashes for sphinx_vhs-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c9bbf917c9212b40080036ea1d083fee14126ea70fe05892c1fff4283db5e355
MD5 90f1d9c6b9f5203aee7be37c5542b728
BLAKE2b-256 6ae23dcec75eefe58dd209f63a09bd7b7d6a218ce019f3931cd4b7e56de59ddb

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