1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
---
title: The Sphinx Book Theme
---
::::{grid}
:reverse:
:gutter: 2 1 1 1
:margin: 4 4 1 1
:::{grid-item}
:columns: 4
```{image} ./_static/logo-square.svg
:width: 150px
```
:::
:::{grid-item}
:columns: 8
:class: sd-fs-3
A Sphinx theme with a clean design, support for interactive content, and a modern book-like look and feel.
:::
::::
[Flexible content layout](reference/special-theme-elements.md)
: Inspired by beautiful online books, such as [the Edward Tufte CSS guide](https://edwardtufte.github.io/tufte-css/)
[Visual classes designed for Jupyter Notebooks](reference/notebooks)
: Cell inputs, outputs, and interactive functionality are all supported.
[Launch buttons for online interactivity](content/launch)
: For pages that are built with computational material, connect your site to an online BinderHub for interactive content.
[Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/)
: To style visual elements and add functionality.
International
: All text integrated in the theme is translated to the specified [Sphinx language](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language).
:::{seealso}
This is the default theme in [Jupyter Book](https://jupyterbook.org).
:::
# Topic areas
The following topic areas will help you understand and use the theme.
```{toctree}
:maxdepth: 1
:caption: Topic Areas
tutorials/get-started
content/index
sections/index
components/index
reference
contributing/index
changelog
```
# Example pages
Examples pages demonstrate the visual look of this theme.
```{toctree}
:caption: Example pages
:maxdepth: 2
reference/kitchen-sink/index
reference/special-theme-elements
reference/extensions
reference/notebooks
reference/thebe
reference/blog
reference/api-numpy
reference/comments
```
# Inspiration
This theme draws inspiration and borrows design elements from the following themes:
- The [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/)
- The [Furo theme](https://pradyunsg.me/furo/)
- The [Edward Tufte CSS theme](https://edwardtufte.github.io/tufte-css/)
- [GitBook](https://docs.gitbook.com/)
- The [Tailwind CSS docs](https://tailwindcss.com/docs/installation)
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-book-theme.svg
[pypi-link]: https://pypi.org/project/sphinx-book-theme
|
