跳至主要内容
Ctrl+K

PyData 主题

  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
    • API
    • PyData 网站
    • NumFocus
    • 捐赠给 NumFocus
  • Twitter
  • GitHub
  • PyPI
  • PyData
  • 用户指南
  • 贡献者指南
  • 示例
  • 变更日志
  • API
  • PyData 网站
  • NumFocus
  • 捐赠给 NumFocus
  • Twitter
  • GitHub
  • PyPI
  • PyData

章节导航

贡献者指南

  • 开始开发
  • 主题结构
  • 主题指南
    • 可访问性检查
    • Web 资源 (CSS/JS/Fonts)
    • 使用 git blame 忽略格式化提交
    • 升级到 Bootstrap 5
    • 在构建过程中更新 Sphinx 配置
    • 更新 JavaScript 依赖项及其版本
    • 图库和 gallery-grid 指令
    • 国际化
    • 更新我们的“厨房水槽”
    • 设置手动开发环境
    • 页面级配置
    • 使用 pre-commit
    • PyData 包支持
    • 预期构建警告

团队实践

  • 合并和审核策略
  • 发布
  • 支持的 Python 和 Sphinx 版本

关于项目

  • 主题贡献者
  • 设计和 UX 灵感来源
  • 贡献者指南
  • 主题指南

主题指南#

这些指南涵盖了与贡献主题相关的特定主题。

  • 可访问性检查
    • 作为开发流程的一部分进行的可访问性检查
  • Web 资源 (CSS/JS/Fonts)
    • 编译和打包资源
    • 样式 (SCSS) 和脚本 (JS)
    • 供应商脚本
    • FontAwesome 图标
    • Jinja 宏
  • 使用 git blame 忽略格式化提交
  • 升级到 Bootstrap 5
    • 弃用 **JQuery**
    • 重大变更
  • 在构建过程中更新 Sphinx 配置
    • 更新配置:使用 app.config
    • 更新主题选项:使用 app.builder.theme_options
    • 检查用户是否提供了默认值:app.config._raw_config
    • 避免 config-inited 事件
  • 更新 JavaScript 依赖项及其版本
  • 图库和 gallery-grid 指令
    • 示例图库
  • 国际化
    • 本地化文件
    • 将字符串标记为可本地化
    • 更新本地化文件
    • 编译本地化文件
    • 添加新语言
    • 本地化主题
    • 本地化技巧
    • 参考资料
  • 更新我们的“厨房水槽”
  • 设置手动开发环境
    • 创建新的开发环境
    • 先决条件
    • 在本地克隆存储库
    • 在本地安装主题
    • 构建文档
    • 编译 Web 资源 (JS/CSS)
    • 启动实时服务器以构建和提供文档
    • 手动运行测试
  • 页面级配置
  • 使用 pre-commit
    • 跳过 pre-commit 检查
    • 在所有文件上运行 pre-commit
  • PyData 包支持
  • 预期构建警告

上一页

主题结构

下一页

可访问性检查

在 GitHub 上编辑
显示源代码

© Copyright 2019, PyData 社区。

使用 Sphinx 8.1.3 创建。

使用 PyData Sphinx 主题 0.16.0 构建。