| Name | teachbooks-sphinx-tippy JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | None |
| Summary | Get rich tool tips in your sphinx book! |
| upload_time | 2025-01-16 14:30:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| 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. |
| keywords |
sphinx
tooltip
tippy
teachbooks
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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).
- Limit the showing of tool tips to the `<main>` anchor of the Sphinx book.
- Limit the maximum height of a tool tip.
- Force tool tips to remain with visible document body.
- No arrow that points from the tool tip to the link.
## 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`.
Raw data
{
"_id": null,
"home_page": null,
"name": "teachbooks-sphinx-tippy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sphinx, tooltip, tippy, teachbooks",
"author": null,
"author_email": "Dennis den Ouden-van der Horst <d.denouden-vanderhorst@tudelft.nl>",
"download_url": "https://files.pythonhosted.org/packages/e5/c3/41eb842ee3d8d68b3b92a072d4e77e6d9978389014761a7fb6f8698a331b/teachbooks_sphinx_tippy-1.0.6.tar.gz",
"platform": null,
"description": "# TeachBooks Sphinx extension: Rich hover over tips\n\nRich tool tips in your TeachBook!\n\n## Introduction\n\nSphinx-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.\n\nThe differences with Sphinx-tippy are:\n\n- Default inclusion of useful CSS-file.\n- Default activation of sphinx.ext.mathjax.\n- Default loading method of _defer_ changed to _None_ for supporting JavaScript.\n- Default support for [TeachBooks Sphinx Grasple](https://github.com/TeachBooks/Sphinx-Grasple-public) such that images are shown (as iframes are not loaded).\n- Limit the showing of tool tips to the `<main>` anchor of the Sphinx book.\n- Limit the maximum height of a tool tip.\n- Force tool tips to remain with visible document body.\n- No arrow that points from the tool tip to the link.\n\n## What does it do?\n\nYou can see how the this works in the [example book](https://teachbooks.io/TeachBooks-sphinx-tippy-Example).\n\n## Installation\nTo install TeachBooks-Sphinx-Tippy, follow these steps:\n\n**Step 1: Install the Package**\n\nInstall the `teachbooks-sphinx-tippy` package using `pip`:\n```\npip install teachbooks-sphinx-tippy\n```\n\n**Step 2: Add to `requirements.txt`**\n\nMake sure that the package is included in your project's `requirements.txt` to track the dependency:\n```\nteachbooks-sphinx-tippy\n```\n\n**Step 3: Enable in `_config.yml`**\n\nIn your `_config.yml` file, add the extension to the list of Sphinx extra extensions (**important**: underscore, not dash this time):\n```\nsphinx: \n extra_extensions:\n - teachbooks_sphinx_tippy\n```\n\n## Usage\n\nBy following the steps above, the extension will be added automatically.\n\n## Contribute\nThis 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`.\n",
"bugtrack_url": null,
"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. ",
"summary": "Get rich tool tips in your sphinx book!",
"version": "1.0.6",
"project_urls": {
"Documentation": "https://github.com/TeachBooks/teachbooks-sphinx-tippy",
"Home": "https://github.com/TeachBooks/teachbooks-sphinx-tippy"
},
"split_keywords": [
"sphinx",
" tooltip",
" tippy",
" teachbooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3aa035a50ea1b7c5dc20fe67200e6ab99a69e9bb681f4ea58cff9f05ac8409ea",
"md5": "4330e8c86a2b911e3035e631bd43cdff",
"sha256": "e98c8d272982f91478fbe63d6468ff15ce7538d365d2630b296ec25bbd678b9e"
},
"downloads": -1,
"filename": "teachbooks_sphinx_tippy-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4330e8c86a2b911e3035e631bd43cdff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12702,
"upload_time": "2025-01-16T14:30:53",
"upload_time_iso_8601": "2025-01-16T14:30:53.101046Z",
"url": "https://files.pythonhosted.org/packages/3a/a0/35a50ea1b7c5dc20fe67200e6ab99a69e9bb681f4ea58cff9f05ac8409ea/teachbooks_sphinx_tippy-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c341eb842ee3d8d68b3b92a072d4e77e6d9978389014761a7fb6f8698a331b",
"md5": "33158264c0232dee42da716b4ae899fc",
"sha256": "b0dea2205dab166d0d40b68fb7786add8c0ee88b43cc2d489f391b3591393f5e"
},
"downloads": -1,
"filename": "teachbooks_sphinx_tippy-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "33158264c0232dee42da716b4ae899fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 122691,
"upload_time": "2025-01-16T14:30:54",
"upload_time_iso_8601": "2025-01-16T14:30:54.990053Z",
"url": "https://files.pythonhosted.org/packages/e5/c3/41eb842ee3d8d68b3b92a072d4e77e6d9978389014761a7fb6f8698a331b/teachbooks_sphinx_tippy-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 14:30:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TeachBooks",
"github_project": "teachbooks-sphinx-tippy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "teachbooks-sphinx-tippy"
}
