贡献指南

感谢您对为 sphinx-book-theme 做出贡献感兴趣！您太棒了✨。

本项目遵循可执行图书项目的贡献指南。其中包含有关我们的编码风格、拉取请求工作流程、提交消息等约定的信息。

这些部分的其余内容包含有关特定开发 sphinx-book-theme 的信息。

贡献指南

• Set up your development workflow
  • Set up your development environment
  • Build the documentation
  • Update the theme's assets (CSS/JS)
  • Auto-build the docs when you make changes
  • Run the tests
  • The {example} directive
• 项目结构
  • src/sphinx_book_theme/ - Theme source files
  • docs/ - Site documentation
  • webpack.config.js and package.json - Webpack and dependencies
  • tests/ - Testing infrastructure
  • .github/workflows/ - Continuous Integration and Deployment
  • Parent theme - pydata-sphinx-theme
• Style and design
  • Design principles and inspiration
  • SCSS build process
  • CSS/SCSS naming conventions
  • SCSS folder structure
• Testing infrastructure
  • Run the tests with a single environment
  • List all test environments
  • Supply arguments to pytest
  • Re-build an environment from scratch
  • Test audits with lighthouse
  • Test multiple Sphinx versions
• Releases and version numbers
  • Release strategy
  • Version numbers
• Translation workflow
  • Structure of translation files
  • Workflow of translations
  • To update a translation
• Creating sub-themes
  • Hashing your assets
  • Defining your own CSS