Skip to main content
Ctrl+K

PyData Theme

  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
    • API
    • PyData Website
    • NumFocus
    • Donate to NumFocus
  • X
  • GitHub
  • PyPI
  • PyData
  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
  • API
  • PyData Website
  • NumFocus
  • Donate to NumFocus
  • X
  • GitHub
  • PyPI
  • PyData

Section Navigation

贡献者指南

  • 开始开发之旅
  • 主题的结构
  • 话题指南
    • 无障碍检查与手动审核
    • 网络资源(CSS/JS/字体)
    • 使用 git blame 忽略格式化提交
    • 升级到 Bootstrap 5
    • 在构建过程中更新 Sphinx 配置
    • 更新 JavaScript 依赖项及其版本
    • 图库和 gallery-grid 指令
    • 国际化
    • 更新我们的综合示例
    • 设置手动开发环境
    • 页面级配置
    • 使用 pre-commit
    • PyData 包支持
    • 预期的构建警告

团队实践

  • Merge and review policy
  • Making releases
  • Supported Python and Sphinx versions

关于项目

  • 此主题的贡献者
  • 设计与用户体验的灵感
  • PyData Sphinx 主题设计系统
  • 贡献者指南
  • 话题指南
  • 图库和 gallery-grid 指令

图库和 gallery-grid 指令#

有几个地方使用 sphinx-design 来生成带有结构化文本和图像的网格“图库”。创建了一个小的 Sphinx 指令,以便在文档中更容易重复此过程,并避免过多重复。它位于 docs/scripts/ 文件夹中的专用模块中,并在我们的文档中重复使用。

示例图库#

此主题的文档包含使用此主题的站点图库。这些图像在 ReadTheDocs 构建期间自动生成,但在本地或测试构建中不会自动生成(以节省时间)。

如果您在本地构建文档时没有首先生成这些图像,可能会收到 Sphinx 警告或错误,但只要图像在 ReadTheDocs 测试中构建成功,这应该没问题。

在本地下载图库图像#

如果您想在本地构建这些图像以在主题中预览,请按照以下步骤操作:

  1. 安装 playwright 和 Chromium 浏览器插件:

    $ pip install playwright
    $ playwright install chromium
    
  2. 从仓库根目录执行图库生成脚本:

    $ python ./docs/scripts/generate_gallery_images.py
    

备注

新生成的图像将被推送到远程仓库。

上一页

更新 JavaScript 依赖项及其版本

下一页

国际化

On this page
  • 示例图库
    • 在本地下载图库图像
在 GitHub 上编辑
显示源代码

© Copyright 2019, PyData Community.

由 Sphinx 8.1.3创建。

Built with the PyData Sphinx Theme 0.16.1.