Developer Guide

Thank you for being interested in contributing to quantecon-book-theme! You are awesome.

This project follows the QuantEcon contribution guidelines. The sections below cover developing quantecon-book-theme specifically.

Developer Guide

• Development Setup
  • Prerequisites
  • Initial Setup
  • Build the Documentation
  • Auto-rebuild During Development
  • Run Tests
  • Code Style
• Repository Architecture
  • Build System
  • src/quantecon_book_theme/ — Theme Source
  • docs/ — Documentation
  • tests/ — Testing
  • External Dependencies (CDN)
  • Parent Theme
• Asset Compilation
  • Quick Reference
  • Workflow
  • Build Dependencies
  • SCSS Architecture
  • JavaScript Architecture
• Testing Guide
  • Running Tests
  • Test Structure
  • Fixtures
  • Module Structure Tests
  • Build Tests
  • Writing New Tests
  • Continuous Integration
• Visual Regression Testing
  • Running Visual Tests
  • CI Integration
  • Test Structure
  • Configuration
• Release Process
  • 1. Pre-Release Validation
  • 2. Version Updates
  • 3. Version Number Guidelines (SemVer)
  • 4. Commit and Tag
  • 5. Create GitHub Release
  • 6. Verify PyPI Publication
  • Common Issues
• Multilingual Support Plan
  • Overview
  • Architecture: Separate Repos per Language
  • URL Structure
  • Theme Modifications
  • Implementation Checklist
  • Open Questions
  • References