Guides

The guides are listed here in the suggested order of reading.

• Installation Guide
  • Prerequisites
  • Installation Methods
  • Verifying Installation
  • Build Configuration
  • Additional Information
• Docker Guide
  • Setting up the Docker Image
  • Running the Docker Image
• Development Guide
  • How It Works
  • Package Structure Overview & Adding new Packages
  • External Implementations
  • Alternative: SKBuild-Based Packages
  • Comparison: External Implementations vs. SKBuild
  • The Build Configuration System
  • Development Workflow
  • Code Formatting
  • Repository Test Runner (scripts/run_tests.sh)
  • Namespace Package Structure and Configuration
• Code Formatting Guide
  • Running Code Formatting
  • Style Configuration
  • Preventing List Collapse with Trailing Commas
  • Exceptions: Disabling Formatting
• Sphinx Documentation Setup Guide
  • Overview
  • Key Features
  • How to Work With the Documentation System
  • Custom Sphinx Extensions and Styling
  • Technical Details
• Contribution Guide
  • Overview
  • Testing Requirements
  • Documentation Requirements
  • Examples and Tutorials
  • Code Quality Standards
  • Getting Help
  • Signing Your Work & Developer Certificate of Origin (DCO)
  • Summary Checklist