Skip to content

docs: Migrate from sphinx_rtd_theme to Furo#13040

Draft
ericholscher wants to merge 2 commits into
mainfrom
claude/furo-docs-theme-5kbI0
Draft

docs: Migrate from sphinx_rtd_theme to Furo#13040
ericholscher wants to merge 2 commits into
mainfrom
claude/furo-docs-theme-5kbI0

Conversation

@ericholscher
Copy link
Copy Markdown
Member

Migrates the documentation theme from sphinx_rtd_theme to furo, a modern, lightweight Sphinx theme that provides better accessibility and customization.

Changes

  • Theme migration: Updated conf.py to use furo instead of sphinx_rtd_theme
  • Logo assets: Added two new SVG logo variants for light and dark modes:
    • logo-dark-text.svg: Dark text logo for light mode backgrounds
    • logo-light-text.svg: Light text logo for dark mode backgrounds
  • Theme configuration: Configured Furo with Read the Docs branding:
    • Brand colors: accent green (#80ba33) for primary, deep navy (#2d4955) for sidebar
    • Custom CSS variables for light and dark modes
    • GitHub repository links and source code navigation
    • Footer icons and announcement banner
  • Custom CSS: Completely rewrote custom.css to work with Furo's CSS variable system:
    • Team roster avatar styling
    • Sidebar logo and branding
    • Announcement banner styling
    • Code highlighting with brand colors
    • External link indicators
    • Button and tab styling
  • Dependencies: Updated requirements/docs.txt to include furo and its dependencies (beautifulsoup4, sphinx-basic-ng, accessible-pygments), removing sphinx-rtd-theme and sphinxcontrib-jquery

The new theme provides a cleaner, more modern documentation experience while maintaining Read the Docs branding and visual identity.


Generated by AI agent

https://claude.ai/code/session_01RiK5zTNNdZBz6jZ3rBxa1u

Replaces sphinx_rtd_theme with Furo and customizes it with the
Read the Docs brand palette, a light/dark wordmark pair, source-edit
buttons, a hosting announcement banner, and polished CSS for code,
links, sidebar captions, sphinx-design buttons and sphinx-tabs.

https://claude.ai/code/session_01RiK5zTNNdZBz6jZ3rBxa1u
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 13, 2026

Documentation build overview

📚 dev | 🛠️ Build #32665047 | 📁 Comparing 7fd5587 against latest (48c24b0)

  🔍 Preview build  

23 files changed · ± 23 modified

± Modified

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 13, 2026

Documentation build overview

📚 docs | 🛠️ Build #32665048 | 📁 Comparing 7fd5587 against latest (e08ef8f)

  🔍 Preview build  

152 files changed · ± 152 modified

± Modified

Drops the custom CSS file and all brand color / typography overrides.
The Furo config now only sets the light/dark logo pair (the white
wordmark would otherwise be invisible in light mode) and hides the
duplicate project name.

https://claude.ai/code/session_01RiK5zTNNdZBz6jZ3rBxa1u
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants