Skip to content

Commit a4646d8

Browse files
geyangclaude
andcommitted
Add root Makefile for documentation build and serve workflows
Provides three convenient targets: - build-docs: Build Sphinx documentation - docs: Build and serve with simple HTTP server on port 8001 - preview: Build and serve with auto-reload on port 8001 All commands use uv run to ensure proper virtual environment activation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent e2bc808 commit a4646d8

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

Makefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.PHONY: build-docs docs preview help
2+
3+
help:
4+
@echo "Available targets:"
5+
@echo " build-docs - Build the Sphinx documentation"
6+
@echo " docs - Build and serve documentation with auto-reload"
7+
@echo " preview - Build and preview documentation in browser"
8+
9+
build-docs:
10+
@echo "Building documentation..."
11+
uv run sphinx-build -M html docs docs/_build
12+
13+
docs: build-docs
14+
@echo "Starting documentation server at http://127.0.0.1:8001"
15+
@echo "Press Ctrl+C to stop the server"
16+
cd docs/_build/html && uv run python -m http.server 8001
17+
18+
preview: build-docs
19+
@echo "Starting documentation server with auto-reload..."
20+
@echo "Documentation will be available at http://127.0.0.1:8001"
21+
uv run sphinx-autobuild docs docs/_build/html --port 8001 --open-browser

0 commit comments

Comments
 (0)