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 主题设计系统
  • 贡献者指南
  • 话题指南

话题指南#

这些话题涵盖了与为此主题做出贡献相关的特定主题。

  • 无障碍检查与手动审核
    • 在本地运行检查
    • 技术细节
    • 已知限制与手动审核
  • 网络资源(CSS/JS/字体)
    • 编译并打包资源
    • 样式(SCSS)和脚本(JS)
    • 第三方脚本
    • FontAwesome 图标
    • Jinja 宏
  • 使用 git blame 忽略格式化提交
  • 升级到 Bootstrap 5
    • Dropping JQuery
    • Breaking changes
  • 在构建过程中更新 Sphinx 配置
    • 更新配置:使用 app.config
    • 更新主题选项:使用 app.builder.theme_options
    • 检查用户是否提供了默认值:app.config._raw_config
    • 避免使用 config-inited 事件
  • 更新 JavaScript 依赖项及其版本
  • 图库和 gallery-grid 指令
    • 示例图库
  • 国际化
    • 本地化文件
    • 将字符串标记为可本地化
    • 更新本地化文件
    • 编译本地化文件
    • 添加新语言
    • 本地化主题
    • 本地化技巧
    • 参考
  • 更新我们的综合示例
  • 设置手动开发环境
    • 创建新的开发环境
    • 先决条件
    • 在本地克隆仓库
    • 在本地安装此主题
    • 构建文档
    • 编译 Web 资源(JS/CSS)
    • 启动实时服务器以构建并提供您的文档
    • 手动运行测试
  • 页面级配置
  • 使用 pre-commit
    • 跳过预提交检查
    • 对所有文件运行预提交
  • PyData 包支持
  • 预期的构建警告

上一页

主题的结构

下一页

无障碍检查与手动审核

在 GitHub 上编辑
显示源代码

© Copyright 2019, PyData Community.

由 Sphinx 8.1.3创建。

Built with the PyData Sphinx Theme 0.16.1.