scripts/build_gh_pages

#!/usr/bin/env bash
#
# Script to generate documentation for Rust crates to publish as gh-pages.
#
# Usage:
#
# ./scipts/build_gh_pages <target_dir>
#
# Where <target_dir> must be an empty directory.

readonly SCRIPTS_DIR="$(dirname "$0")"
# shellcheck source=scripts/common
source "$SCRIPTS_DIR/common"

readonly TARGET_DIR="${1:-}"

if [[ -z "${TARGET_DIR}" ]]; then
  echo 'target dir not specified'
  exit 1
fi

if [[ ! -d "${TARGET_DIR}" ]]; then
  echo 'target not a directory'
  exit 1
fi

if [[ -n "$(ls "${TARGET_DIR}"/*)" ]]; then
  echo 'target dir not empty'
  exit 1
fi

# Absolute path to the target directory, to make sure that docs are generated into the correct directory.
readonly TARGET_ABS_PATH="$(realpath "${TARGET_DIR}")"

# All the dirs that we want to generate docs for.
declare -ar SOURCE_PATHS=(
  'oak_abi'
  'oak_derive'
  'oak_io'
  'oak_loader'
  'oak_runtime'
  'oak_services'
  'oak_sign'
  'oak_utils'
  'runner'
  'sdk'
)
declare -ar TARGET_SUBDIRS=(
  'oak_abi'
  'oak_derive'
  'oak_io'
  'oak_loader'
  'oak_runtime'
  'oak_services'
  'oak_sign'
  'oak_utils'
  'runner'
  'oak'
)

# Titles used in the top-level index.html files.
declare -ar PAGE_TITLES=(
  'ABI'
  'Derive'
  'IO'
  'Loader'
  'Runtime'
  'Services'
  'Sign'
  'Utils'
  'Runner'
  'SDK'
)

readonly LEN=${#SOURCE_PATHS[@]}

for ((i=0;i<LEN;i++)); do
  (
    cd "${SOURCE_PATHS[$i]}"

    target_dir="${TARGET_ABS_PATH}/${SOURCE_PATHS[$i]}"
    mkdir --parent "${target_dir}"

    # Generate docs directly into the target dir.
    cargo doc --no-deps --target-dir="${target_dir}"

    # Remove non-doc artifacts from the target dir.
    rm --recursive --force "${target_dir}/debug"

    # Remove non-deterministic files.
    rm "${target_dir}/.rustc_info.json"

    # The docs generated from the Cargo workspace do not include a workspace-level index, so we generate
    # one here and redirect to the appropriate documentation.
    cat <<-END > "${target_dir}/index.html"
      <!DOCTYPE html>
      <html>
        <head>
          <meta http-equiv="Refresh" content="0; url=./doc/${TARGET_SUBDIRS[$i]}/index.html" />
        </head>
        <body>
          <p><a href="./doc/${TARGET_SUBDIRS[$i]}/index.html">Oak ${PAGE_TITLES[$i]} main page</a></p>
        </body>
      </html>
END
  )
done

# A top-level index so that visiting https://project-oak.github.io/oak/ goes somewhere helpful.
cat <<-END > "${TARGET_ABS_PATH}/index.html"
  <!DOCTYPE html>
  <html>
    <head>
      <meta http-equiv="Refresh" content="0; url=./sdk/doc/oak/index.html" />
    </head>
    <body>
      <p><a href="./sdk/doc/oak/index.html">Oak SDK main page</a></p>
    </body>
  </html>
END