0d0297423e
Some checks failed
CI/CD Pipeline / Test Suite (push) Has been cancelled
CI/CD Pipeline / Security Audit (push) Has been cancelled
CI/CD Pipeline / Performance Benchmarks (push) Has been cancelled
Rust CI / Security Audit (push) Has been cancelled
Rust CI / Check + Test + Lint (nightly) (push) Has been cancelled
Rust CI / Check + Test + Lint (stable) (push) Has been cancelled
CI/CD Pipeline / Build Docker Image (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Cleanup (push) Has been cancelled
58 lines
1.6 KiB
Plaintext
58 lines
1.6 KiB
Plaintext
# =============================================================================
|
|
# DOCUMENTATION COMMANDS - Rustelo Framework
|
|
# =============================================================================
|
|
# Documentation generation and management
|
|
|
|
# Build all documentation
|
|
docs-build:
|
|
@echo "📚 Building documentation..."
|
|
./scripts/docs/build-docs.sh
|
|
|
|
# Serve documentation locally
|
|
docs-serve:
|
|
@echo "📚 Serving documentation..."
|
|
./scripts/docs/docs-dev.sh
|
|
|
|
# Setup documentation system
|
|
docs-setup:
|
|
@echo "📚 Setting up documentation system..."
|
|
./scripts/docs/setup-docs.sh
|
|
|
|
# Deploy documentation to GitHub Pages
|
|
docs-deploy-github:
|
|
@echo "📚 Deploying docs to GitHub Pages..."
|
|
./scripts/docs/deploy-docs.sh github
|
|
|
|
# Deploy documentation to Netlify
|
|
docs-deploy-netlify:
|
|
@echo "📚 Deploying docs to Netlify..."
|
|
./scripts/docs/deploy-docs.sh netlify
|
|
|
|
# Generate API documentation
|
|
docs-api:
|
|
@echo "📚 Generating API documentation..."
|
|
cargo doc --all-features --no-deps --open
|
|
|
|
# Build cargo documentation with assets
|
|
docs-cargo:
|
|
@echo "📚 Building cargo documentation with assets..."
|
|
cp -r logos/ target/doc/
|
|
cargo doc --all-features --no-deps
|
|
|
|
# Validate documentation
|
|
docs-validate:
|
|
@echo "📚 Validating documentation..."
|
|
mdbook test book/
|
|
|
|
# Clean documentation build
|
|
docs-clean:
|
|
@echo "📚 Cleaning documentation..."
|
|
rm -rf _book/
|
|
rm -rf book-output/
|
|
cargo clean --doc
|
|
|
|
# Generate content for documentation
|
|
docs-generate-content:
|
|
@echo "📚 Generating documentation content..."
|
|
./scripts/docs/generate-content.sh
|