Skip to main content
Ctrl+K
⚠️The latest release refactored our HTML, so double-check your custom CSS rules!⚠️
Sphinx Book Theme - Home Sphinx Book Theme - Home
  • Executable Books
  • GitHub
  • PyPI

Topic Areas

  • Get started
  • Content and formatting
    • Special content blocks
    • PyData Theme Elements
    • Jupyter notebooks
    • Launch buttons for interactivity
  • Layout and major sections
    • Primary sidebar and navigation
    • Secondary sidebar and table of contents
    • Header and navbar
    • Content footer
    • Page footer
    • Announcement banners
  • Component customization
    • Logo and branding
    • Icon links and badges
    • Add a download page button
    • Buttons that link to source files
    • Add your own CSS rules
  • Reference of theme options
  • Contributing guide
    • Set up your development workflow
    • Architecture of the repository
    • Style and design
    • Testing infrastructure
    • Releases and version numbers
    • Translation workflow
    • Creating sub-themes
  • Changelog

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
    • Tables
    • Typography
  • Theme-specific elements
  • Sphinx extension styles
  • Jupyter notebooks
  • Thebe
  • Reference for Blog
  • NumPy docstrings
  • Comments
  • Show source
  • Suggest edit
  • Open issue
  • .md

Content and formatting

Content and formatting#

These sections describe content-specific customization and formatting.

  • Special content blocks
    • Quotations and epigraphs
    • Sidenotes and marginnotes
      • Activate sidenotes and marginnotes
      • Create a sidenote
      • Create a marginnote
    • Block margin content with the {margin} directive
      • Figure captions in the margin
      • CSS classes for custom margin content
      • Content examples in the margin
    • Sidebars
    • Full-width content
  • PyData Theme Elements
    • Mathematics
    • Code blocks
    • Inline code
    • Code execution
    • Admonition sidebars
    • Footnotes
    • Link shortening for git repository services
  • Jupyter notebooks
    • Markdown + notebooks
    • Code blocks and image outputs
    • Removing content before publishing
    • Rich outputs from notebook cells
    • Formatting code cells
      • Scrolling cell outputs
      • Scrolling cell inputs
  • Launch buttons for interactivity
    • Binder / BinderHub
    • JupyterHub
    • Google Colab
    • Deepnote
    • Live code cells with Thebe
    • Configure a relative path to your source file
    • Control the user interface that is opened

previous

Get started

next

Special content blocks

By the Executable Book Project

© Copyright 2025.

Last updated on Apr 06, 2025.