forked from bendalab/plottools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbuild-docs.sh
executable file
·51 lines (41 loc) · 1.13 KB
/
build-docs.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#!/bin/bash
die () { echo "ERROR: $*" >&2; exit 2; }
for cmd in pdoc3; do
command -v "$cmd" >/dev/null ||
die "Missing $cmd; \`pip install $cmd\`"
done
PACKAGE="plottools"
PACKAGESRC="src/$PACKAGE"
PACKAGEROOT="$(dirname "$(realpath "$0")")"
BUILDROOT="$PACKAGEROOT/site"
APIIMAGEFOLDER='figures'
APIIMAGES="$PACKAGEROOT/docs/$APIIMAGEFOLDER"
echo
echo "Clean up documentation of $PACKAGE"
echo
rm -rf "$BUILDROOT" 2> /dev/null || true
mkdir -p "$BUILDROOT"
echo "Building general documentation for $PACKAGE"
echo
cd "$PACKAGEROOT"
mkdocs build --config-file .mkdocs.yml --site-dir "$BUILDROOT"
cd - > /dev/null
echo
echo "Building API reference docs for $PACKAGE"
echo
cd "$PACKAGEROOT"
pdoc3 --html --config sort_identifiers=False --output-dir "$BUILDROOT/api-tmp" $PACKAGESRC
mkdir "$BUILDROOT/api-tmp/$PACKAGE/$APIIMAGEFOLDER"
cp "$APIIMAGES/"*.png "$BUILDROOT/api-tmp/$PACKAGE/$APIIMAGEFOLDER/"
mv "$BUILDROOT/api-tmp/$PACKAGE" "$BUILDROOT/api"
rmdir "$BUILDROOT/api-tmp"
cd - > /dev/null
echo
echo "Done. Docs in:"
echo
echo " file://$BUILDROOT/index.html"
echo
echo "Check with:"
echo
echo " mkdocs serve -f .mkdocs.yml"
echo