https://github.com/nickderobertis/sphinx-terminhtml

Write bash commands in a Sphinx directive, output an animated HTML/CSS terminal
https://github.com/nickderobertis/sphinx-terminhtml

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nickderobertis/sphinx-terminhtml
• Owner: nickderobertis
• License: mit
• Created: 2022-05-05T20:30:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-14T02:57:51.000Z (about 3 years ago)
• Last Synced: 2025-02-27T09:27:00.815Z (4 months ago)
• Language: Python
• Size: 1.08 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![](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/

)