Rocket/scripts/mk-docs.sh

31 lines
946 B
Bash
Raw Normal View History

2016-10-03 00:29:59 +00:00
#!/bin/bash
set -e
#
# Builds the rustdocs for all of the libraries.
#
# Brings in: PROJECT_ROOT, EXAMPLES_DIR, LIB_DIR, CODEGEN_DIR, CONTRIB_DIR, DOC_DIR
2016-10-03 00:29:59 +00:00
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
source "${SCRIPT_DIR}/config.sh"
2016-10-03 00:29:59 +00:00
if [ "${1}" != "-d" ]; then
# We need to clean-up beforehand so we don't get all of the dependencies.
echo ":::: Cleaning up before documenting..."
cargo clean
cargo update
fi
# Generate the rustdocs for all of the crates.
2018-10-07 04:16:02 +00:00
echo ":::: Generating the docs..."
pushd "${PROJECT_ROOT}" > /dev/null 2>&1
# Set the crate version and fill in missing doc URLs with docs.rs links.
RUSTDOCFLAGS="-Zunstable-options --crate-version ${DOC_VERSION}" \
cargo doc -p rocket \
-p rocket_sync_db_pools -p rocket_dyn_templates -p rocket_db_pools -p rocket_ws \
-Zrustdoc-map --no-deps --all-features
2018-10-07 04:16:02 +00:00
popd > /dev/null 2>&1
# Blank index, for redirection.
touch "${DOC_DIR}/index.html"