Skip to content

Check for missing dependencies before building the website #1678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion website/build_website.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
#!/bin/bash
#
# This script generates documentation using pydoc-markdown and renders the website using Quarto.
#
# Usage: bash build_website.sh

missing_deps=false

#
# Check for missing dependencies, report them, and exit when building the
# website is likely to fail.
#
for dependency in node pydoc-markdown quarto python yarn npm
do
if ! command -v "$dependency" &> /dev/null
then
echo "Command '$dependency' not found."
missing_deps=true
fi
done

if [ "$missing_deps" = true ]
then
echo -e "\nSome of the dependencies are missing."
echo "Please install them to build the website."
exit 1
fi

# Generate documentation using pydoc-markdown
pydoc-markdown
Expand Down