Contributor Guide

These pages contain information about the community that leads, supports, and develops this theme, including how you can contribute to the project.

Contributor guide

• Get started with development
  • Testing pre-release and nightly
  • Workflow for contributing changes
  • Clone the repository
  • Install your tools
  • Build the documentation
  • Compile the CSS/JS assets
  • Run a development server
  • Run the tests
  • GitHub Codespaces
• Structure of this theme
  • Location and structure of documentation
  • Location and structure of CSS/JS assets
• Topic guides
  • Accessibility checks and manual auditing
  • Web assets (CSS/JS/Fonts)
  • Ignore formatting commits with git blame
  • Upgrade to bootstrap 5
  • Update Sphinx configuration during the build
  • Update JavaScript dependencies and their versions
  • Galleries and the gallery-grid directive
  • Internationalization
  • Update our kitchen sink
  • Set up a manual development environment
  • Page-level configuration
  • Using pre-commit
  • PyData package support
  • Expected build warnings

Team practices

• Merge and review policy
  • Policy for moderate changes
  • Policy for major new features and breaking changes
  • Policy For minor changes and bugfixes
• Making releases
  • Our goals
  • When to make a release
    • Release candidates
  • Process for making a release
  • Choosing a version increment
• Supported Python and Sphinx versions
  • Supported Python versions
  • Supported Sphinx versions

About the project

• Contributors to this theme
  • Collaborators on the repository
  • Financial support
  • Theme logo
• Inspiration for design and UX
• PyData Sphinx Theme Design System
  • Guiding Principles
  • Typography
  • Color
  • Relevant Links
• Accessibility Statement for Pydata Sphinx Theme Draft
  • Scope of statement
  • Measures to support accessibility
  • Conformance
  • Known issues
  • Testing and compatibility
  • Assessment approach
  • Date