Metadata-Version: 2.1
Name: teachbooks_sphinx_tippy
Version: 1.0.3
Summary: Get rich tool tips in your sphinx book!
Author-email: Dennis den Ouden-van der Horst <d.denouden-vanderhorst@tudelft.nl>
License: MIT License
        
        Copyright (c) 2023 Chris Sewell
        
        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: Home, https://github.com/TeachBooks/teachbooks-sphinx-tippy
Project-URL: Documentation, https://github.com/TeachBooks/teachbooks-sphinx-tippy
Keywords: sphinx,tooltip,tippy,teachbooks
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx>4
Requires-Dist: beautifulsoup4
Requires-Dist: jinja2
Requires-Dist: requests
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: sphinx-pytest; extra == "testing"
Requires-Dist: pytest-regressions; extra == "testing"
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"

# TeachBooks Sphinx extension: Rich hover over tips

Rich tool tips in your TeachBook!

## Introduction

Sphinx-tippy allows you to create rich hover over tips as demonstrated here: https://sphinx-tippy.readthedocs.io/en/latest/. This TeachBooks Tippy extension makes it plug-and-play within a TeachBook.

The differences with Sphinx-tippy are:

- Default inclusion of useful CSS-file.
- Default activation of sphinx.ext.mathjax.
- Default loading method of _defer_ changed to _None_ for supporting JavaScript.
- Default support for [TeachBooks Sphinx Grasple](https://github.com/TeachBooks/Sphinx-Grasple-public) such that images are shown (as iframes are not loaded).

Future differences with Sphinx-tippy are:

- Addition of a directive _repeat_ to show content explicity. 

## What does it do?

You can see how the this works in the [example book](https://teachbooks.io/TeachBooks-sphinx-tippy-Example).

## Installation
To install TeachBooks-Sphinx-Tippy, follow these steps:

**Step 1: Install the Package**

Install the `teachbooks-sphinx-tippy` package using `pip`:
```
pip install teachbooks-sphinx-tippy
```

**Step 2: Add to `requirements.txt`**

Make sure that the package is included in your project's `requirements.txt` to track the dependency:
```
teachbooks-sphinx-tippy
```

**Step 3: Enable in `_config.yml`**

In your `_config.yml` file, add the extension to the list of Sphinx extra extensions (**important**: underscore, not dash this time):
```
sphinx: 
    extra_extensions:
        - teachbooks_sphinx_tippy
```

## Usage

By following the steps above, the extension will be added automatically.

## Contribute
This tool's repository is stored on [GitHub](https://github.com/TeachBooks/teachbooks-sphinx-tippy). The `README.md` of the branch `Manual` is also part of the [TeachBooks manual](https://teachbooks.io/manual/intro.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/teachbooks-sphinx-tippy). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git`.
