PyData Sphinx 主题#
由 PyData 社区 开发和维护的干净、基于 Bootstrap 的 Sphinx 主题。
使用 Bootstrap 构建
使用 Bootstrap 的类和功能编写文档。
响应式设计
网站的各个部分在不同屏幕尺寸下会改变行为和大小。
明亮/暗黑主题
用户可以通过交互方式切换明亮和暗黑主题。
可定制的 UI 和主题
使用 CSS 变量自定义颜色和品牌,并使用 Sphinx Design 组件 构建自定义 UI。
支持 PyData 和 Jupyter
支持 Jupyter 扩展 和 PyData 执行输出 的 CSS 和 UI。
示例库
查看我们的 示例库,了解这个主题的使用示例。
参见
如果你正在寻找一个将所有子页面放在侧边栏的 Sphinx 主题,Sphinx Book Theme 有类似的外观和感觉,Furo 是另一个很好的选择。你还可以查看 Sphinx Themes Gallery 获取更多想法。
用户指南#
关于使用、配置和自定义这个主题的信息。
社区和贡献指南#
关于这个主题背后的社区以及你如何贡献的信息。
示例#
几个示例页面,演示了在与其他 Sphinx 扩展一起使用时,这个主题的功能。
- 示例
- 使用此主题的网站展示
- Kitchen Sink
- PyData Library Styles
- 执行库
- Graphviz
- 1. Test of no sidebar
- 2. Test of persistent search field
- 3. 无右侧边栏的页面内目录测试
- 4. Section to show off pages with many sub pages
- 5. Top-level headers and the TOC
- 6. An example with multiple top-level headers
- 7. An example with a single top-level header
- 链接到外部网站
API#
暴露的 pydata_sphinx_theme
API 的内容。