From e1fc3f696fc716be5da4ba5daf482ce491bf6c8f Mon Sep 17 00:00:00 2001 From: douden <49307154+douden@users.noreply.github.com> Date: Tue, 26 Nov 2024 08:11:41 +0100 Subject: [PATCH] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 50761bf..fca9c0d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# Sphinx extension: Rich hover over tips +# 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 JupyterBook. +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. ## 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 the Sphinx-Image-Inverter, follow these steps: +To install TeachBooks-Sphinx-Tippy, follow these steps: **Step 1: Install the Package** @@ -40,6 +40,5 @@ sphinx: 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`.