-
Notifications
You must be signed in to change notification settings - Fork 283
Expand file tree
/
Copy pathbuild-rust-docs.sh
More file actions
executable file
·61 lines (51 loc) · 1.92 KB
/
build-rust-docs.sh
File metadata and controls
executable file
·61 lines (51 loc) · 1.92 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
#!/bin/bash
# Build Rust documentation and create redirect index.html
# Note that you should make sure "import binaryninja" will return the
# correct version for the docs you want to upload.
set -e
CARGO_TOML="rust/Cargo.toml"
CARGO_LOCK="Cargo.lock"
# Check for uncommitted changes to Cargo.toml or Cargo.lock
if ! git diff --quiet "$CARGO_TOML" "$CARGO_LOCK" 2>/dev/null; then
echo "Error: Uncommitted changes detected in $CARGO_TOML or $CARGO_LOCK"
echo "Please commit or stash your changes before running this script."
exit 1
fi
# Get Binary Ninja version from Python one-liner
echo "Getting Binary Ninja version..."
BN_VERSION=$(python3 -c "import binaryninja; v = binaryninja.core_version_info(); print(f'{v.major}.{v.minor}.{v.build}')")
echo "Binary Ninja version: $BN_VERSION"
# Function to restore Cargo.toml and Cargo.lock on exit
cleanup() {
echo "Restoring $CARGO_TOML and $CARGO_LOCK..."
git checkout "$CARGO_TOML" "$CARGO_LOCK" 2>/dev/null || true
}
trap cleanup EXIT
# Update version in Cargo.toml
echo "Updating version to $BN_VERSION in $CARGO_TOML..."
sed -i '' "s/^version = \".*\"/version = \"$BN_VERSION\"/" "$CARGO_TOML"
# Clean out old docs
echo "Cleaning target/doc directory..."
rm -rf target/doc
# Build the documentation (without dependencies by default)
echo "Building documentation..."
cargo doc --no-deps "$@"
# Create redirect index.html
echo "Creating redirect index.html..."
cat > target/doc/index.html <<'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; url=/binaryninja/index.html">
<title>Binary Ninja Rust Documentation</title>
<script>
window.location.href = "/binaryninja/index.html";
</script>
</head>
<body>
<p>Redirecting to <a href="/binaryninja/index.html">Binary Ninja Rust documentation</a>...</p>
</body>
</html>
EOF
echo "Documentation built successfully with redirect at target/doc/index.html"