libei/doc/protocol/generate-protocol-docs.sh
Peter Hutterer 6b7424e821 doc/proto: fix a bug with the pages script
Removing the chapter pages means the directory no longer exists, so we
manually have to mkdir it.
2023-03-08 16:07:00 +10:00

92 lines
2.1 KiB
Bash
Executable file

#!/usr/bin/env bash
#
set -e
REPO_BASE_DIR="$PWD"
OUTDIR="$PWD"
SITENAME="ei"
while [[ $# -gt 0 ]]; do
case "$1" in
--verbose | -v)
set -x
shift
;;
--scanner)
SCANNER="$2"
shift 2;
;;
--protocol)
PROTOFILE="$2"
shift 2
;;
--template-dir)
TEMPLATEDIR="$2"
shift 2
;;
--output-dir)
OUTDIR="$2"
shift 2
;;
--git-repo)
REPO_BASE_DIR="$2"
shift 2;
;;
**)
echo "Unknown argument: $1"
exit 1
;;
esac
done
if [[ -z "$SCANNER" ]]; then
SCANNER="$REPO_BASE_DIR/proto/ei-scanner"
fi
if [[ -z "$PROTOFILE" ]]; then
PROTOFILE="$REPO_BASE_DIR/proto/protocol.xml"
fi
if [[ -z "$TEMPLATEDIR" ]]; then
TEMPLATEDIR="$REPO_BASE_DIR/doc/protocol/"
fi
SITEDIR="$OUTDIR/$SITENAME"
if [[ -e "$SITEDIR" ]]; then
echo "$SITEDIR already exists, updating"
else
hugo new site "$SITEDIR"
git clone --depth=1 https://github.com/McShelby/hugo-theme-relearn "$SITEDIR/themes/hugo-theme-relearn"
fi
cp "$TEMPLATEDIR/config.toml" "$SITEDIR/"
pushd "$SITEDIR" > /dev/null || exit 1
# Generate a list of available interfaces and read that
# list line-by-line to generate a separate .md file
# for each interface
mkdir -p "$SITEDIR/content/interfaces"
while read -r iface; do
$SCANNER --component=ei --jinja-extra-data="{ \"interface\": \"$iface\" }" --output="$SITEDIR/content/interfaces/$iface.md" "$PROTOFILE" "$TEMPLATEDIR/interface.md.tmpl"
done < <($SCANNER --component=ei "$PROTOFILE" - <<EOF
{% for interface in interfaces %}
{{interface.name}}
{% endfor %}
EOF
)
mkdir -p "$SITEDIR/content/doc"
cp "$TEMPLATEDIR/_index.md" "$SITEDIR/content"
cp "$TEMPLATEDIR/overview.md" "$SITEDIR/content/doc"
cp "$TEMPLATEDIR/types.md" "$SITEDIR/content/doc"
cp "$TEMPLATEDIR/specification.md" "$SITEDIR/content/doc"
cp "$TEMPLATEDIR/initial-handshake.md" "$SITEDIR/content/doc"
cp "$TEMPLATEDIR/interface-index.md" "$SITEDIR/content/interfaces/_index.md"
cp "$TEMPLATEDIR/chapter-index.md" "$SITEDIR/content/doc/_index.md"
hugo
popd > /dev/null || exit 1