| Name | sphinx-book-theme JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | |
| Summary | A clean book theme for scientific explanations and documentation with Sphinx |
| upload_time | 2024-02-13 20:52:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2020, Chris Holdgraf All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-book-theme
[![codecov][codecov-badge]][codecov-link] [![Documentation Status][rtd-badge]][rtd-link] [![PyPI][pypi-badge]][pypi-link]
**An interactive book theme for Sphinx**.
This is a lightweight Sphinx theme designed to mimic the look-and-feel of an
interactive book. It has the following primary features:
* **Bootstrap 5**
for visual elements and functionality.
* **Flexible content layout** that is inspired by beautiful online books,
such as [the Edward Tufte CSS guide](https://edwardtufte.github.io/tufte-css/)
* **Visual classes designed for Jupyter Notebooks**. Cell inputs, outputs,
and interactive functionality are all supported.
* **Launch buttons for online interactivity**. For pages that are built with
computational material, connect your site to an online BinderHub for interactive content.
## Get started
To get started with `sphinx-book-theme`, first install it with `pip`:
```
pip install sphinx-book-theme
```
then, activate the theme in your Sphinx configuration (`conf.py`):
```
...
html_theme = "sphinx_book_theme"
...
```
This will activate the Sphinx Book Theme for your documentation. Note that you may
need to change your `html_theme_options` configuration depending on your previous
theme. See the pages to the left for information about what you can configure with
`sphinx-book-theme`.
## Documentation
See [the Sphinx Book Theme documentation](https://sphinx-book-theme.readthedocs.io/en/latest/)
for more information.
[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-book-theme
[rtd-badge]: https://readthedocs.org/projects/sphinx-book-theme/badge/?version=latest
[rtd-link]: https://sphinx-book-theme.readthedocs.io/en/latest/?badge=latest
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-book-theme.svg
[pypi-link]: https://pypi.org/project/sphinx-book-theme
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-book-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Executable Books Team <executablebooks@gmail.com>",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ad/e1/a619b051f05b3efc93b06b9b734ce9a595676ce4f6d21ae5cabf0a610993/sphinx_book_theme-1.1.2.tar.gz",
"platform": null,
"description": "# sphinx-book-theme\n\n[![codecov][codecov-badge]][codecov-link] [![Documentation Status][rtd-badge]][rtd-link] [![PyPI][pypi-badge]][pypi-link]\n\n**An interactive book theme for Sphinx**.\n\nThis is a lightweight Sphinx theme designed to mimic the look-and-feel of an\ninteractive book. It has the following primary features:\n\n* **Bootstrap 5**\n for visual elements and functionality.\n* **Flexible content layout** that is inspired by beautiful online books,\n such as [the Edward Tufte CSS guide](https://edwardtufte.github.io/tufte-css/)\n* **Visual classes designed for Jupyter Notebooks**. Cell inputs, outputs,\n and interactive functionality are all supported.\n* **Launch buttons for online interactivity**. For pages that are built with\n computational material, connect your site to an online BinderHub for interactive content.\n\n## Get started\n\nTo get started with `sphinx-book-theme`, first install it with `pip`:\n\n```\npip install sphinx-book-theme\n```\n\nthen, activate the theme in your Sphinx configuration (`conf.py`):\n\n```\n...\nhtml_theme = \"sphinx_book_theme\"\n...\n```\n\nThis will activate the Sphinx Book Theme for your documentation. Note that you may\nneed to change your `html_theme_options` configuration depending on your previous\ntheme. See the pages to the left for information about what you can configure with\n`sphinx-book-theme`.\n\n## Documentation\n\nSee [the Sphinx Book Theme documentation](https://sphinx-book-theme.readthedocs.io/en/latest/)\nfor more information.\n\n[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/master/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-book-theme\n\n[rtd-badge]: https://readthedocs.org/projects/sphinx-book-theme/badge/?version=latest\n[rtd-link]: https://sphinx-book-theme.readthedocs.io/en/latest/?badge=latest\n\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-book-theme.svg\n[pypi-link]: https://pypi.org/project/sphinx-book-theme\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2020, Chris Holdgraf All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A clean book theme for scientific explanations and documentation with Sphinx",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://sphinx-book-theme.readthedocs.io/",
"Repository": "https://github.com/executablebooks/sphinx-book-theme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de51468988ebfbefedf468f421c633fb6c974ccc81418f916705b4eb02ba3167",
"md5": "87f5de3f429e1eeee68adb69321645fb",
"sha256": "cee744466fde48f50302b851291b208aa67e726ca31b7a3bfb9b6e6a145663e0"
},
"downloads": -1,
"filename": "sphinx_book_theme-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87f5de3f429e1eeee68adb69321645fb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 400780,
"upload_time": "2024-02-13T20:52:36",
"upload_time_iso_8601": "2024-02-13T20:52:36.993432Z",
"url": "https://files.pythonhosted.org/packages/de/51/468988ebfbefedf468f421c633fb6c974ccc81418f916705b4eb02ba3167/sphinx_book_theme-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ade1a619b051f05b3efc93b06b9b734ce9a595676ce4f6d21ae5cabf0a610993",
"md5": "e1e26deec25df98a845b37deec86c865",
"sha256": "7f3abcd146ca82e6f39d6db53711102b1c1d328d12f65e3e47ad9bf842614a49"
},
"downloads": -1,
"filename": "sphinx_book_theme-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e1e26deec25df98a845b37deec86c865",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 292817,
"upload_time": "2024-02-13T20:52:39",
"upload_time_iso_8601": "2024-02-13T20:52:39.546195Z",
"url": "https://files.pythonhosted.org/packages/ad/e1/a619b051f05b3efc93b06b9b734ce9a595676ce4f6d21ae5cabf0a610993/sphinx_book_theme-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 20:52:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "sphinx-book-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-book-theme"
}
