sphinx-bootstrap-theme

What it is and what it does

Sphinx Bootstrap Theme wraps Sphinx documentation generation with Bootstrap's CSS and JavaScript framework, providing a responsive HTML layout out of the box. It integrates hierarchical navigation menus, mobile-friendly design, and optional Bootswatch color themes to customize the visual appearance of your docs without writing custom CSS.

You configure it by importing the theme in your Sphinx conf.py and setting a few options—navbar title, navigation links, Bootswatch theme name, and Bootstrap version preference. The theme handles the rest, rendering your reStructuredText documentation with Bootstrap's grid, components, and responsive behavior. It supports Bootstrap v2.3.2 and v3.3.7, though v3 is recommended.

Use it for:

• Apply a polished, modern look to Sphinx documentation without custom CSS or template work.
• Build mobile-responsive documentation sites that work well on phones and tablets.
• Use a Bootswatch theme to quickly rebrand documentation with a different color scheme.
• Add hierarchical dropdown menus and site navigation to Sphinx-generated HTML.
• Migrate from plain Sphinx HTML to a Bootstrap-based layout for existing projects.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx theme that applies Bootstrap CSS and JavaScript to documentation, offering responsive design, configurable navigation, and support for Bootswatch color schemes.

No. The package is abandoned with no releases since 2022-02-03 and targets Bootstrap v2.3.2 and v3.3.7, which are now outdated. Modern Sphinx projects should use actively maintained alternatives. If you have legacy documentation already using this theme, it may continue to work, but do not adopt it for new projects.

Install

sphinx-bootstrap-theme on PyPI

pip install sphinx-bootstrap-theme

uv add sphinx-bootstrap-theme

poetry add sphinx-bootstrap-theme

Installing sphinx-bootstrap-theme

Before you install

Installation is straightforward with no runtime dependencies. However, the package has been abandoned since its last release on 2022-02-03, so expect no maintenance, bug fixes, or updates for compatibility with newer Sphinx or Bootstrap versions.

License in practice

Licensed under MIT (permissive), so you can use, modify, and distribute it freely with minimal restrictions.

Quickstart

pip install sphinx-bootstrap-theme

# In conf.py:
import sphinx_bootstrap_theme
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

Verify before relying

• Compatibility with current Sphinx versions and Python 3.10+ not confirmed in fact sheet.
• Whether Bootswatch theme integration still works given Bootstrap and Bootswatch evolution since 2022.
• Whether the theme works with Bootstrap versions beyond v2.3.2 and v3.3.7.

Package facts

Evidence: sphinx_bootstrap_theme-0.8.1-py2.py3-none-any.whl

Keywords: sphinx, bootstrap, html, theme

Tags

More Internet packages