Topic guides

These guides cover specific topics that are relevant to contributing to this theme.

• Accessibility checks and manual auditing
  • Running the checks locally
  • Technical details
  • Known limitations and manual auditing
• Web assets (CSS/JS/Fonts)
  • Compile and bundle assets
  • Styles (SCSS) and Scripts (JS)
  • Vendored scripts
  • FontAwesome icons
  • Jinja macros
• Ignore formatting commits with git blame
• Upgrade to bootstrap 5
  • Dropping JQuery
  • Breaking changes
• Update Sphinx configuration during the build
  • Update config: use app.config
  • Update theme options: use app.builder.theme_options
  • Check if a user has provided a default: app.config._raw_config
  • Avoid the config-inited event
• Update JavaScript dependencies and their versions
• Galleries and the gallery-grid directive
  • The example gallery
• Internationalization
  • Localization files
  • Marking strings as localizable
  • Updating the localization files
  • Compiling the localization files
  • Adding a new language
  • Localizing the theme
  • Localization tips
  • References
• Update our kitchen sink
• Set up a manual development environment
  • Create a new development environment
  • Pre-requisites
  • Clone the repository locally
  • Install this theme locally
  • Build the documentation
  • Compile web assets (JS/CSS)
  • Start a live server to build and serve your documentation
  • Manually run the tests
• Page-level configuration
• Using pre-commit
  • Skip the pre-commit checks
  • Run pre-commit on all files
• PyData package support
• Expected build warnings