Metadata-Version: 2.1
Name: sphinx-vhs
Version: 0.0.1
Summary: Sphinx plugin that generates terminal GIFs using charm's VHS
Author-email: Tamika Nomara <taminomara@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Tamika Nomara
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://taminomara.github.io/sphinx-vhs/
Project-URL: Issues, https://github.com/taminomara/sphinx-vhs/issues/
Project-URL: Source, https://github.com/taminomara/sphinx-vhs/
Project-URL: Changelog, https://github.com/taminomara/sphinx-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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: doc
License-File: LICENSE

# 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://taminomara.github.io/sphinx-vhs/)
- [Issues](https://github.com/taminomara/sphinx-vhs/issues/)
- [Source](https://github.com/taminomara/sphinx-vhs/)
- [PyPi](https://pypi.org/project/sphinx-vhs/)
- [Changelog](https://github.com/taminomara/sphinx-vhs/blob/main/CHANGELOG.md)
