Metadata-Version: 2.4
Name: sphinx-vhs
Version: 1.3.0
Summary: Sphinx plugin that generates terminal GIFs using charm's VHS
Author-email: Tamika Nomara <taminomara@gmail.com>
License-Expression: MIT
Project-URL: Documentation, https://sphinx-vhs.readthedocs.io/en/stable/
Project-URL: Issues, https://github.com/sphinx-contrib/vhs/issues/
Project-URL: Source, https://github.com/sphinx-contrib/vhs/
Project-URL: Changelog, https://github.com/sphinx-contrib/vhs/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Intended Audience :: Developers
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx<9.0,>=8.0
Requires-Dist: vhs<2.0,>=1.0.0
Dynamic: license-file

# 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.

[VHS]: https://github.com/charmbracelet/vhs
[charm]: https://charm.sh/

## Resources

- [Documentation](https://sphinx-vhs.readthedocs.io/en/stable/)
- [Issues](https://github.com/sphinx-contrib/vhs/issues/)
- [Source](https://github.com/sphinx-contrib/vhs/)
- [PyPi](https://pypi.org/project/sphinx-vhs/)
- [Changelog](https://github.com/sphinx-contrib/vhs/blob/main/CHANGELOG.md)

## Requirements

- python >= 3.11
- sphinx >= 8.0

## Installation

```sh
pip install sphinx-vhs
```
