PyData Sphinx 主题

一个由 PyData 社区 为其创建的干净、基于 Bootstrap 的 Sphinx 主题。

使用 Bootstrap 构建

在您的文档中使用 Bootstrap 类和功能。

响应式设计

网站部分将在不同的屏幕尺寸下改变行为和大小。

亮色/暗色主题

用户可以交互式地切换亮色和暗色主题。

可自定义的 UI 和主题

使用 CSS 变量自定义颜色和品牌，并使用 Sphinx Design 组件 构建自定义 UI。

支持 PyData 和 Jupyter

对 Jupyter 扩展 和 PyData 执行输出 的 CSS 和 UI 支持。

示例库

请查看 我们的库，其中包含使用此主题的项目示例。

另请参阅

如果您正在寻找一个将所有子页面都放在侧边栏中的 Sphinx 主题，则 Sphinx Book 主题 具有类似的外观和感觉，而 Furo 是另一个不错的选择。您还可以查看 Sphinx 主题库 以获取更多想法。

用户指南

有关使用、配置和自定义此主题的信息。

• 用户指南
  • 安装
  • 主题结构和布局
  • 导航深度和折叠侧边栏
  • 页面目录
  • 页眉链接
  • 源代码按钮
  • Sphinx 索引
  • 公告横幅
  • 版本切换下拉菜单
  • 搜索栏/搜索按钮
  • 键盘快捷键
  • 国际化
  • 返回顶部按钮
  • 特定于主题的元素
  • 使用 ABlog 的博客
  • Sphinx Design 组件
  • 扩展主题
  • 品牌和徽标
  • 主题变量和 CSS
  • 字体和 FontAwesome
  • 亮色和暗色主题
  • 无障碍访问
  • 分析和使用服务
  • 添加自定义 CSS 和 JS 资产
  • 构建性能和大小
  • 主题更改、弃用和警告
  • Read the Docs 功能

社区和贡献指南

有关此主题背后的社区以及如何贡献的信息。

• 贡献者指南
  • 开始开发
  • 此主题的结构
  • 主题指南
  • 合并和审查策略
  • 发布
  • 支持的 Python 和 Sphinx 版本
  • 此主题的贡献者
  • 设计和 UX 灵感来源

示例

一些示例页面，展示了此主题与其他 Sphinx 扩展一起使用时的功能。

• 示例
  • 使用此主题的网站库
  • 样例集
  • PyData 库样式
  • 执行库
  • Graphviz
  • 1. 无侧边栏测试
  • 2. 持久搜索栏测试
  • 3. 无右侧边栏的页面内目录测试
  • 4. 用于展示包含多个子页面的页面的部分
  • 5. 顶层标题和目录
  • 6. 包含多个顶层标题的示例
  • 7. 包含单个顶层标题的示例
  • 链接到外部网站

API

公开的 pydata_sphinx_theme API 的内容。

• API
  • pydata_sphinx_theme