Skip to content

Commit 6785167

Browse files
committed
Remove redundant build-docs-local.sh and enhance main build script
- Remove scripts/build-docs-local.sh (redundant with comprehensive build-docs.sh) - Update doc/codeDocs/README.md to reference main build script - Add --open flag to build-docs.sh for automatic browser opening on macOS - Enhance developer experience with file:// URL output and CI detection - Consolidate documentation build workflow to single, robust script This simplifies the build process while maintaining all functionality: - Comprehensive builds with proper error handling and logging - Optional browser auto-open for local development - Consistent output paths (documentation-output/) - Full CI/CD compatibility
1 parent bcac596 commit 6785167

File tree

3 files changed

+17
-55
lines changed

3 files changed

+17
-55
lines changed

doc/CodeDocs/README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,18 @@ This directory contains the **enhanced** auto-generated API documentation for th
3333

3434
### Quick Local Build
3535
```bash
36-
# Use the enhanced build script (recommended)
37-
./scripts/build-docs-local.sh
38-
```
36+
# Use the comprehensive build script (recommended)
37+
./scripts/build-docs.sh
3938

40-
### Manual Build Process
41-
```bash
42-
# Install enhanced documentation dependencies
43-
pip install -r requirements-docs.txt
39+
# Or build and automatically open in browser (macOS)
40+
./scripts/build-docs.sh --open
41+
```
4442

45-
# Generate enhanced analysis and diagrams
46-
python scripts/generate-docs.py --src src --output doc/codeDocs
43+
```
4744
48-
# Generate API documentation
49-
sphinx-apidoc -o doc/codeDocs/ src/ --force --no-toc --module-first
45+
### Manual Build Process
5046
51-
# Build enhanced HTML documentation
52-
sphinx-build -b html doc/codeDocs/ doc/codeDocs/_build/html
53-
```
47+
```bash
5448
5549
### System Requirements
5650
- **Graphviz**: Required for diagram generation
@@ -111,8 +105,8 @@ This enhanced codeDocs integrates with the broader documentation structure:
111105
## 🚀 Getting Started
112106

113107
1. **Install dependencies**: `pip install -r requirements-docs.txt`
114-
2. **Run enhanced build**: `./scripts/build-docs-local.sh`
115-
3. **View documentation**: Open `doc/codeDocs/_build/html/index.html`
108+
2. **Run comprehensive build**: `./scripts/build-docs.sh`
109+
3. **View documentation**: Open `documentation-output/html/index.html`
116110
4. **Explore features**: Navigate to "Overview" for architecture diagrams
117111

118112
## 🔍 Advanced Features

scripts/build-docs-local.sh

Lines changed: 0 additions & 39 deletions
This file was deleted.

scripts/build-docs.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,13 @@ main() {
372372
if [ "$build_success" = true ]; then
373373
log_success "Documentation build completed successfully!"
374374
log_info "Output directory: $DOCS_OUTPUT"
375+
log_info "Documentation available at: file://$DOCS_OUTPUT/html/index.html"
376+
377+
# Check if --open flag was passed or if running locally (not in CI)
378+
if [[ "$*" == *"--open"* ]] || [[ -z "$CI" && "$OSTYPE" == "darwin"* ]]; then
379+
log_info "Opening documentation in browser..."
380+
open "$DOCS_OUTPUT/html/index.html" 2>/dev/null || true
381+
fi
375382
else
376383
log_error "Documentation build completed with errors"
377384
exit 1

0 commit comments

Comments
 (0)