mirror of
https://github.com/rwf2/Rocket.git
synced 2024-12-26 12:22:36 +00:00
5a4e66ec43
This follows the completed graduation of stable contrib features into core, removing 'rocket_contrib' in its entirety in favor of two new crates. These crates are versioned independently of Rocket's core libraries, allowing upgrades to dependencies without consideration for versions in core libraries. 'rocket_dyn_templates' replaces the contrib 'templates' features. While largely a 1-to-1 copy, it makes the following changes: * the 'tera_templates' feature is now 'tera' * the 'handlebars_templates' feature is now 'handlebars' * fails to compile if neither 'tera' nor 'handlebars' is enabled 'rocket_sync_db_pools' replaces the contrib 'database' features. It makes no changes to the replaced features except that the `database` attribute is properly documented at the crate root.
30 lines
908 B
Bash
Executable File
30 lines
908 B
Bash
Executable File
#!/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
|
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
source "${SCRIPT_DIR}/config.sh"
|
|
|
|
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.
|
|
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 \
|
|
-Zrustdoc-map --no-deps --all-features
|
|
popd > /dev/null 2>&1
|
|
|
|
# Blank index, for redirection.
|
|
touch "${DOC_DIR}/index.html"
|