sphinx-book-theme
一个用于Sphinx的交互式书籍主题。
这是一个轻量级的Sphinx主题,旨在模仿交互式书籍的外观和感觉。它具有以下主要特点:
- Bootstrap 5 用于视觉元素和功能。
- 灵活的内容布局,灵感来自于美观的在线书籍, 如Edward Tufte CSS指南
- 为Jupyter Notebooks设计的视觉类。支持单元格输入、输出 和交互功能。
- 用于在线交互的启动按钮。对于使用计算材料构建的页面,将您的网站连接到在线BinderHub以实现交互式内容。
入门
要开始使用sphinx-book-theme
,首先通过pip
安装它:
pip install sphinx-book-theme
然后,在您的Sphinx配置(conf.py
)中激活主题:
...
html_theme = "sphinx_book_theme"
...
这将为您的文档激活Sphinx Book主题。请注意,根据您之前的主题,您可能需要更改html_theme_options
配置。有关可以使用sphinx-book-theme
配置的内容,请参阅左侧的页面。
文档
有关更多信息,请参阅Sphinx Book Theme文档。