Metadata-Version: 2.1
Name: sphinx-terminhtml
Version: 1.0.0
Summary: Write bash commands in a Sphinx directive, output an animated HTML/CSS terminal
Home-page: https://github.com/nickderobertis/sphinx-terminhtml
Author: Nick DeRobertis
Author-email: derobertis.nick@gmail.com
License: MIT
Project-URL: Code, https://github.com/nickderobertis/sphinx-terminhtml
Project-URL: Documentation, https://nickderobertis.github.io/sphinx-terminhtml
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

[![](https://codecov.io/gh/nickderobertis/sphinx-terminhtml/branch/main/graph/badge.svg)](https://codecov.io/gh/nickderobertis/sphinx-terminhtml)
[![PyPI](https://img.shields.io/pypi/v/sphinx-terminhtml)](https://pypi.org/project/sphinx-terminhtml/)
![PyPI - License](https://img.shields.io/pypi/l/sphinx-terminhtml)
[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/sphinx-terminhtml/)
[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/sphinx-terminhtml/)


#  sphinx-terminhtml

## Overview

Write bash commands in a Sphinx directive, output an animated HTML/CSS terminal

## Getting Started

Install `sphinx-terminhtml`:

```
pip install sphinx-terminhtml
```

A simple example:

```python
import sphinx_terminhtml

# Do something with sphinx_terminhtml
```

See a
[more in-depth tutorial here.](
https://nickderobertis.github.io/sphinx-terminhtml/tutorial.html
)

## Development Status

This project is currently in early-stage development. There may be
breaking changes often. While the major version is 0, minor version
upgrades will often have breaking changes.

## Author

Created by Nick DeRobertis. MIT License.

## Links

See the
[documentation here.](
https://nickderobertis.github.io/sphinx-terminhtml/
)


