Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

3.7 KB
Raw Blame
#!/bin/bash
# Estella Documentation Build Script (Linux/macOS)
# Usage: ./build.sh [dev|build|all]

set -e

DOCS_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
COMMAND="${1:-all}"

print_header() {
    echo ""
    echo "========================================"
    echo " $1"
    echo "========================================"
    echo ""
}

build_doxygen() {
    print_header "Building Doxygen API Documentation"

    cd "$DOCS_ROOT"

    if ! command -v doxygen &> /dev/null; then
        echo "ERROR: Doxygen not found. Please install it first."
        echo "  Ubuntu/Debian: sudo apt install doxygen"
        echo "  macOS: brew install doxygen"
        exit 1
    fi

    # PROJECT_NUMBER is injected from the single app-version source.
    export ESTELLA_VERSION="$(node -p "require('../desktop/package.json').version" 2>/dev/null || echo '')"
    doxygen Doxyfile

    echo "Doxygen build complete: docs/api/html/"
}

build_astro() {
    print_header "Building Astro Documentation Site"

    cd "$DOCS_ROOT/astro"

    if [ ! -d "node_modules" ]; then
        echo "Installing dependencies..."
        npm install
    fi

    npm run build

    echo "Astro build complete: docs/astro/dist/"
}

sync_api_docs() {
    echo "Syncing Doxygen API docs to Astro public..."

    API_SOURCE="$DOCS_ROOT/api/html"
    API_DEST="$DOCS_ROOT/astro/public/api/html"

    if [ -d "$API_SOURCE" ]; then
        mkdir -p "$DOCS_ROOT/astro/public/api"
        cp -r "$API_SOURCE" "$DOCS_ROOT/astro/public/api/"
        echo "API docs synced."
    else
        echo "No API docs found. Run './build.sh doxygen' first."
    fi
}

start_dev() {
    print_header "Starting Astro Dev Server"

    # Sync API docs before starting dev server
    sync_api_docs

    cd "$DOCS_ROOT/astro"

    if [ ! -d "node_modules" ]; then
        echo "Installing dependencies..."
        npm install
    fi

    echo "Starting dev server at http://localhost:4321"
    npm run dev
}

merge_output() {
    print_header "Merging Documentation Output"

    OUTPUT_DIR="$DOCS_ROOT/dist"

    # Clean output directory
    rm -rf "$OUTPUT_DIR"
    mkdir -p "$OUTPUT_DIR"

    # The same layout .github/workflows/docs.yml publishes: the landing page at
    # the root, the guides under /docs, the C++ reference under /docs/api/html.
    # A local build that arranges them differently is a preview of a site that
    # does not exist.
    if [ -d "$DOCS_ROOT/landing" ]; then
        cp -r "$DOCS_ROOT/landing/." "$OUTPUT_DIR/"
        # The page states the version it was built from — see docs.yml.
        version=$(node -p "require('$DOCS_ROOT/../desktop/package.json').version")
        sed -i "s/__ESTELLA_VERSION__/$version/g" "$OUTPUT_DIR/index.html"
    fi

    # Copy Astro output
    if [ -d "$DOCS_ROOT/astro/dist" ]; then
        mkdir -p "$OUTPUT_DIR/docs"
        cp -r "$DOCS_ROOT/astro/dist/"* "$OUTPUT_DIR/docs/"
    fi

    # Copy Doxygen output
    if [ -d "$DOCS_ROOT/api/html" ]; then
        mkdir -p "$OUTPUT_DIR/docs/api/html"
        cp -r "$DOCS_ROOT/api/html/"* "$OUTPUT_DIR/docs/api/html/"
    fi

    echo "Documentation merged to: docs/dist/"
}

# Main
case "$COMMAND" in
    dev)
        start_dev
        ;;
    doxygen)
        build_doxygen
        ;;
    astro)
        build_astro
        ;;
    build|all)
        build_doxygen
        build_astro
        merge_output
        ;;
    *)
        echo "Usage: ./build.sh [command]"
        echo ""
        echo "Commands:"
        echo "  dev      Start Astro dev server"
        echo "  doxygen  Build only Doxygen API docs"
        echo "  astro    Build only Astro site"
        echo "  build    Build everything"
        echo "  all      Build everything (default)"
        ;;
esac