The QuantEcon Book Theme

An interactive book theme for Sphinx.

A lightweight Sphinx theme designed to mimic the look-and-feel of an interactive book. Key features:

• Dark mode — modern dark theme with full syntax highlighting, accessible colors, no flash on load

• Git-based metadata — automatic last-modified timestamps and interactive changelog per page

• Collapsible stderr warnings — wrap verbose notebook warnings in an expandable interface

• Bootstrap 4 for visual elements

• Flexible content layout inspired by Edward Tufte CSS

• Jupyter Notebook support with visual classes for cell inputs, outputs, and interactivity

• Configurable code highlighting — QuantEcon styles or Pygments built-in themes

• Launch buttons — connect to BinderHub, JupyterHub, Colab, or Thebe for interactive content

• Text color schemes — Seoul256, Gruvbox, or custom colors for emphasis and bold

• RTL support — full right-to-left layout for Arabic, Hebrew, Persian, and more

Quick Start

pip install quantecon-book-theme

# conf.py
html_theme = "quantecon_book_theme"

User Guide

Everything you need to install, configure, and use the theme.

User Guide

• User Guide
  • Requirements
  • Installation
  • Quick Start
  • What’s in this guide

Developer Guide

Contributing, architecture, testing, and release processes.

Developer Guide

• Developer Guide
  • Development Setup
  • Repository Architecture
  • Asset Compilation
  • Testing Guide
  • Visual Regression Testing
  • Release Process
  • Multilingual Support Plan

Reference

Reference

• Sub-sections example
  • Demo Paragraph Level Markup
  • Layout and demo and reference
  • Sub-chapter 1
  • Sub-chapter 2 - this time with a longer name
  • The first chapter page
  • A second chapter page
  • A third chapter page
  • Sample notebook page
• Python API
  • __version__
  • add_to_context()
  • add_hub_urls()

Acknowledgements

This theme is heavily inspired by (and dependent on) PyData Sphinx Theme for its base structure and configuration.