Skip to main content
`Ctrl`+`K`
⚠️The latest release refactored our HTML, so double-check your custom CSS rules!⚠️

# Topic areas

A Sphinx theme with a clean design, support for interactive content, and a modern book-like look and feel.

Flexible content layout

  Inspired by beautiful online books, such as the Edward Tufte CSS guide

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.

Bootstrap 5

  To style visual elements and add functionality.

International

  All text integrated in the theme is translated to the specified Sphinx language.

See also

This is the default theme in Jupyter Book.

# Topic areas

The following topic areas will help you understand and use the theme.

Topic Areas

- Get started
- Content and formatting
- Layout and major sections
- Component customization
- Reference of theme options
- Contributing guide
- Changelog

# Example pages

Examples pages demonstrate the visual look of this theme.

Example pages

- Kitchen Sink
  - Admonitions
  - API documentation
  - Blocks
  - Generic items
  - Images & Figures
  - Lists
  - Really Long Page Title because we should test sidebar wrapping
  - Structural Elements
  - Structural Elements 2
  - Tables
  - Typography
- Theme-specific elements
  - Full-width elements
  - Margins
  - Sidenotes and marginnotes
  - Nested admonitions
  - MyST Markdown elements
- Sphinx extension styles
  - `sphinxcontrib-bibtex` - References and bibliographies
  - `ABlog` - Blog post list
  - `sphinx-togglebutton` - Toggle content with buttons
  - `sphinx-tabs` - Tabbed content
  - `sphinxcontrib.youtube` for videos
  - `sphinx-design` for UI components
- Jupyter notebooks
  - Hiding elements
  - Enriched outputs
  - Interactive outputs
  - Stdout
  - Formatting code cells
- Thebe
  - Code style
- Reference for Blog
- NumPy docstrings
  - NumPy
  - `array()`
  - `transpose()`
- Comments
  - Hypothes.is
  - Utterances

# Inspiration

This theme draws inspiration and borrows design elements from the following themes:

- The PyData Sphinx Theme

- The Furo theme

- The Edward Tufte CSS theme

- GitBook

- The Tailwind CSS docs