mirror of
https://github.com/mailscope/kumomta.git
synced 2026-09-06 02:28:56 +00:00
Wez Furlong
837f9e5c0e
I definitely forgot to do this on the very first change after adding them, so I want to make it less likely in the future. This causes the specs to get updated in the docs if they have changed (other than the version field) since the last time they were updated. We check this during test and doc building. That should be sufficient to catch this during my dev loop. refs: https://github.com/KumoCorp/kumomta/issues/96
70 lines
1.5 KiB
Bash
Executable File
70 lines
1.5 KiB
Bash
Executable File
#!/bin/bash
|
|
set -e
|
|
set -x
|
|
|
|
SERVE=no
|
|
if [ "$1" == "serve" ] ; then
|
|
SERVE=yes
|
|
fi
|
|
|
|
tracked_markdown=$(mktemp)
|
|
trap "rm ${tracked_markdown}" "EXIT"
|
|
find docs -type f | egrep '\.(markdown|md)$' > $tracked_markdown
|
|
|
|
cargo_deps="gelatyx"
|
|
|
|
for doc_dep in $cargo_deps ; do
|
|
if ! hash $doc_dep 2>/dev/null ; then
|
|
cargo install $doc_dep --locked
|
|
fi
|
|
done
|
|
|
|
if test -z "${CHECK_ONLY}" ; then
|
|
gelatyx --language lua --file-list $tracked_markdown --language-config stylua.toml
|
|
fi
|
|
if ! gelatyx --language lua --color always --file-list $tracked_markdown --language-config stylua.toml --check ; then
|
|
echo
|
|
echo "Be sure to run ./docs/build.sh to apply formatting before you push changes."
|
|
echo
|
|
exit 1
|
|
fi
|
|
|
|
if test -x target/debug/kumod ; then
|
|
./docs/update-openapi.sh
|
|
fi
|
|
|
|
# https://github.com/rust-lang/cargo/issues/2025
|
|
# Document only our own crates
|
|
# TODO: consider using:
|
|
# <https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#rustdoc-map>
|
|
cargo tree --depth 0 -e normal --prefix none | \
|
|
cut -d' ' -f1 | sort -u | xargs printf -- '-p %s\n' | \
|
|
xargs cargo doc --no-deps --locked --lib
|
|
|
|
python3 docs/generate-toc.py || exit 1
|
|
|
|
PIP=pip
|
|
if command -v pip3 >/dev/null ; then
|
|
PIP=pip3
|
|
fi
|
|
|
|
# Adjust path to pick up pip-installed binaries
|
|
PATH="$HOME/.local/bin;$PATH"
|
|
${PIP} install --quiet \
|
|
mkdocs-material \
|
|
mkdocs-git-revision-date-localized-plugin \
|
|
black \
|
|
mkdocs-exclude \
|
|
mkdocs-macros-plugin \
|
|
pillow \
|
|
cairosvg
|
|
|
|
# Keep the toc generator formatted
|
|
black docs/generate-toc.py
|
|
|
|
if [ "$SERVE" == "yes" ] ; then
|
|
mkdocs "$@"
|
|
else
|
|
mkdocs build
|
|
fi
|