mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-05-22 03:59:33 -05:00
0911074243
The docs/modules/ directory is gitignored since these are generated files. Build script now copies src/*/ABOUT.md to docs/modules/*_ABOUT.md before building, ensuring all 20 module pages appear in the sidebar navigation.
97 lines
2.8 KiB
Bash
Executable File
97 lines
2.8 KiB
Bash
Executable File
#!/bin/bash
|
|
# TinyTorch Website Build Script
|
|
# Jupyter Book 1.x (Sphinx) Build System
|
|
# Quick and easy: ./docs/build.sh (from root) or ./build.sh (from docs/)
|
|
|
|
set -e # Exit on error
|
|
|
|
echo "🏗️ Building TinyTorch documentation website (Jupyter Book 1.x)..."
|
|
echo ""
|
|
|
|
# Detect where we're running from and navigate to docs directory
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
DOCS_DIR=""
|
|
PROJECT_ROOT=""
|
|
|
|
if [ -f "_config.yml" ]; then
|
|
# Already in docs directory
|
|
DOCS_DIR="$(pwd)"
|
|
PROJECT_ROOT="$(dirname "$DOCS_DIR")"
|
|
elif [ -f "docs/_config.yml" ]; then
|
|
# In root directory
|
|
PROJECT_ROOT="$(pwd)"
|
|
DOCS_DIR="$(pwd)/docs"
|
|
cd "$DOCS_DIR"
|
|
echo "📂 Changed to docs directory: $DOCS_DIR"
|
|
else
|
|
echo "❌ Error: Cannot find docs directory with _config.yml"
|
|
echo " Run from project root or docs/ directory"
|
|
exit 1
|
|
fi
|
|
|
|
# Switch to Node.js v20 (required for Jupyter Book compatibility)
|
|
if command -v nvm &> /dev/null; then
|
|
echo "🔧 Switching to Node.js v20..."
|
|
source "$HOME/.nvm/nvm.sh"
|
|
nvm use 20
|
|
echo ""
|
|
elif [ -s "$HOME/.nvm/nvm.sh" ]; then
|
|
echo "🔧 Switching to Node.js v20..."
|
|
source "$HOME/.nvm/nvm.sh"
|
|
nvm use 20
|
|
echo ""
|
|
fi
|
|
|
|
# Activate virtual environment if it exists and we're not already in it
|
|
if [ -z "$VIRTUAL_ENV" ] && [ -f "$PROJECT_ROOT/.venv/bin/activate" ]; then
|
|
echo "🔧 Activating virtual environment..."
|
|
source "$PROJECT_ROOT/.venv/bin/activate"
|
|
elif [ -z "$VIRTUAL_ENV" ]; then
|
|
echo "⚠️ Warning: No virtual environment detected"
|
|
echo " Recommend running: source scripts/activate-tinytorch"
|
|
fi
|
|
|
|
# Verify jupyter-book is available
|
|
if ! command -v jupyter-book &> /dev/null; then
|
|
echo "❌ Error: jupyter-book not found"
|
|
echo " Install with: pip install jupyter-book"
|
|
exit 1
|
|
fi
|
|
|
|
echo "📦 Using: $(which jupyter-book)"
|
|
echo " Version: $(jupyter-book --version | head -1)"
|
|
echo ""
|
|
|
|
# Clean previous build
|
|
if [ -d "_build" ]; then
|
|
echo "🧹 Cleaning previous build..."
|
|
rm -rf _build
|
|
echo ""
|
|
fi
|
|
|
|
# Copy module ABOUT.md files from src/ to docs/modules/
|
|
echo "📋 Copying module ABOUT files..."
|
|
mkdir -p modules
|
|
for i in 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20; do
|
|
src_dir=$(find "$PROJECT_ROOT/src" -maxdepth 1 -type d -name "${i}_*" | head -1)
|
|
if [ -n "$src_dir" ] && [ -f "$src_dir/ABOUT.md" ]; then
|
|
module_name=$(basename "$src_dir")
|
|
cp "$src_dir/ABOUT.md" "modules/${module_name}_ABOUT.md"
|
|
fi
|
|
done
|
|
echo " Copied $(ls modules/*_ABOUT.md 2>/dev/null | wc -l | tr -d ' ') module files"
|
|
echo ""
|
|
|
|
# Build the site
|
|
echo "🚀 Building Jupyter Book site..."
|
|
echo ""
|
|
jupyter-book build . --all
|
|
|
|
echo ""
|
|
echo "✅ Build complete!"
|
|
echo ""
|
|
echo "📖 To view the site locally:"
|
|
echo " jupyter-book start"
|
|
echo " (This will start a MyST server and open your browser)"
|
|
echo ""
|