-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathMakefile
More file actions
66 lines (55 loc) · 1.9 KB
/
Copy pathMakefile
File metadata and controls
66 lines (55 loc) · 1.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Makefile for PyP6Xer Documentation
.PHONY: help docs clean install serve
# Default target
help:
@echo "PyP6Xer Documentation Build System"
@echo ""
@echo "Available targets:"
@echo " install Install documentation dependencies"
@echo " docs Build HTML documentation"
@echo " clean Clean build files"
@echo " serve Serve documentation locally"
@echo " publish Build and publish documentation"
@echo " help Show this help message"
# Install documentation dependencies
install:
@echo "Installing documentation dependencies..."
pip install -r docs/requirements.txt
@echo "Dependencies installed successfully!"
# Build documentation
docs:
@echo "Building documentation..."
cd docs && sphinx-build -b html source build/html
@echo "Documentation built successfully!"
@echo "Open docs/build/html/index.html to view"
# Clean build files
clean:
@echo "Cleaning documentation build files..."
rm -rf docs/build/
rm -rf docs/source/api/xerparser/
@echo "Clean complete!"
# Serve documentation locally
serve: docs
@echo "Serving documentation at http://localhost:8000"
cd docs/build/html && python -m http.server 8000
# Build for publication
publish: clean docs
@echo "Documentation ready for publication in docs/build/html/"
# Development build with auto-reload
dev:
@echo "Starting development server with auto-reload..."
cd docs && sphinx-autobuild source build/html --host 0.0.0.0 --port 8000
# Check for broken links
linkcheck:
@echo "Checking for broken links..."
cd docs && sphinx-build -b linkcheck source build/linkcheck
# Build PDF documentation (requires LaTeX)
pdf:
@echo "Building PDF documentation..."
cd docs && sphinx-build -b latex source build/latex
cd docs/build/latex && make
@echo "PDF documentation built in docs/build/latex/"
# Check documentation syntax
doctest:
@echo "Running documentation tests..."
cd docs && sphinx-build -b doctest source build/doctest