{"library":"sphinx-book-theme","title":"Sphinx Book Theme","type":"library","description":"Sphinx Book Theme is a lightweight Sphinx theme designed to mimic the look-and-feel of an interactive book, utilizing Bootstrap 5 for visual elements and functionality. It provides visual classes tailored for Jupyter Notebooks, supporting cell inputs, outputs, and interactive features. The current version is 1.2.0, released in March 2026. However, the project is officially in maintenance mode, accepting bug fixes but with limited new feature development due to a lack of dedicated resources.","language":"python","status":"maintenance","last_verified":"Fri May 22","install":{"commands":["pip install sphinx-book-theme"],"cli":null},"imports":["html_theme = \"sphinx_book_theme\""],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://sphinx-book-theme.readthedocs.io","github":"https://github.com/executablebooks/sphinx-book-theme","docs":"https://sphinx-book-theme.readthedocs.io/","changelog":null,"pypi":"https://pypi.org/project/sphinx-book-theme/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# 1. Create a new Sphinx project (if you don't have one)\nsphinx-quickstart\n\n# 2. Install the theme\npip install sphinx-book-theme\n\n# 3. Edit conf.py in your Sphinx project's source directory\n#    Add 'sphinx_book_theme' to the html_theme variable:\n#    html_theme = \"sphinx_book_theme\"\n#    Optionally, add theme options, e.g., for a GitHub button:\n#    html_theme_options = {\n#        \"repository_url\": \"https://github.com/executablebooks/sphinx-book-theme\",\n#        \"use_repository_button\": True,\n#        \"path_to_docs\": \"docs\", # relative path to docs root from repo root\n#        \"home_page_in_toc\": True,\n#    }\n\n# 4. Create an index.rst (or .md if using MyST-parser) and other content files\n#    Example index.rst:\n#    ====================\n#    Welcome to My Book!\n#    ====================\n#\n#    .. toctree::\n#       :hidden:\n#       :maxdepth: 2\n#       :caption: Contents\n#\n#       page1\n#       page2\n\n# 5. Build your documentation\nmake html # or sphinx-build -M html . _build","lang":"bash","description":"To quickly set up documentation with Sphinx Book Theme, first initialize a Sphinx project using `sphinx-quickstart`. Then, install the theme via pip. The core step involves modifying your `conf.py` file to set `html_theme = \"sphinx_book_theme\"` and optionally configure `html_theme_options` for features like a repository link. Finally, build your documentation using `make html` or `sphinx-build`.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-22","installed_version":"1.1.4","pypi_latest":"1.2.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.8,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"102.1M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.7,"import_time_s":null,"mem_mb":null,"disk_size":"103M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"113.7M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.8,"import_time_s":null,"mem_mb":null,"disk_size":"114M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"104.5M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.5,"import_time_s":null,"mem_mb":null,"disk_size":"105M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"104.4M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.3,"import_time_s":null,"mem_mb":null,"disk_size":"105M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"101.5M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinx-book-theme","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":6.7,"import_time_s":null,"mem_mb":null,"disk_size":"102M"}]}}