diff options
| author | Jordan Wiens <github@psifertex.com> | 2025-12-01 18:45:14 -0500 |
|---|---|---|
| committer | Jordan Wiens <github@psifertex.com> | 2025-12-01 18:45:14 -0500 |
| commit | ae7e093c4d75b6aa133753cac3911eb74908e205 (patch) | |
| tree | cfb16afb8473f84b4f6c0c92b7e0c5fad07ce788 /scripts/build-rust-docs.sh | |
| parent | 816e90c9ef4b2093b4245a992e5ca576fb9da8e4 (diff) | |
rust doc generation script
Diffstat (limited to 'scripts/build-rust-docs.sh')
| -rwxr-xr-x | scripts/build-rust-docs.sh | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/scripts/build-rust-docs.sh b/scripts/build-rust-docs.sh new file mode 100755 index 00000000..1c18071d --- /dev/null +++ b/scripts/build-rust-docs.sh @@ -0,0 +1,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" |