Repository navigation
Expand file tree
/
Copy pathrun_typedoc.sh
More file actions
executable file
·118 lines (99 loc) · 3.73 KB
/
Copy pathrun_typedoc.sh
File metadata and controls
executable file
·118 lines (99 loc) · 3.73 KB
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#!/bin/bash
# Runs typedoc on various Pulumi repos and copies them to
# the /libraries folder.
# NOTE: typedoc needs to be installed globally (see README.md) rather than
# in a local node_modules folder. This is because typedoc does not correctly
# support relative paths within a TypeScript file. (So, you can point it at a folder,
# but if those .ts files use a path like "..\", typedoc will fail to resolve as intended.)
set -o errexit -o pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
TOOL_TYPEDOC="$SCRIPT_DIR/../node_modules/.bin/typedoc"
TOOL_TYPEDOC_CONFIG="$SCRIPT_DIR/../typedoc.json"
OUTDIR="${SCRIPT_DIR}/../static-prebuilt/docs/reference/pkg/nodejs/pulumi"
# Set this to 1 to run all generation in parallel.
PARALLEL=0
# Generates API documentation for a given package. The arguments are:
# * $1 - the simple name of the package (e.g., "azure" for the pulumi-azure package)
# * $2 - the typescript entry point file for the package, relative to the source directory, usually index.ts.
# * $3 - the package root directory (to run `make ensure` for dependency updates)
# * $4 - the package source directory, relative to the root, optionally empty if the same
# If the PKGS envvar is set, only packages in that list (space delimited) are regenerated.
generate_docs() {
GENPKG=""
if [[ -z "$PKGS" ]]; then
GENPKG=$1
else
for PKG in ${PKGS}; do
if [[ "$PKG" == "$1" ]]; then
GENPKG=$1
fi
done
fi
if [[ ! -z "$GENPKG" ]]; then
echo -e "\033[0;95m$1\033[0m"
echo -e "\033[0;93mGenerating pulumi.com API docs\033[0m"
# Change to the target directory and rebuild if necessary.
PKGPATH=../$3
pushd $PKGPATH
if [[ -z "$NOBUILD" ]]; then
git clean -xdf
make ensure && make build && make install
fi
if [[ ! -z "$4" ]]; then
PKGPATH=$PKGPATH/$4
cd $4
fi
PKG_REPO_DIR=$3
if [[ ! -z "$4" ]]; then
PKG_REPO_DIR=$PKG_REPO_DIR/$4
fi
${TOOL_TYPEDOC} --out "${OUTDIR}/$1" \
--excludeInternal --excludeExternals --excludePrivate \
--cleanOutputDir \
--skipErrorChecking \
--includeVersion \
--options "$TOOL_TYPEDOC_CONFIG" \
"$2"
popd
fi
}
REPOS=(
"policy,index.ts,pulumi-policy,sdk/nodejs/policy"
"pulumi,index.ts,pulumi/sdk/nodejs"
"esc-sdk,index.ts,esc-sdk/sdk/typescript/esc"
"cloud-sdk,src/index.ts,pulumi-cloud-sdk/nodejs"
)
PIDS=()
# run processes and store pids in array
for repo in ${REPOS[*]}
do
IFS=',' read -r -a repo_parts <<< "$repo"
SIMPLE_NAME=${repo_parts[0]}
ENTRY_POINT=${repo_parts[1]}
PACKAGE_NAME=${repo_parts[2]}
ROOT_PATH=${repo_parts[3]}
if [ "$PARALLEL" -eq "1" ]; then
generate_docs $SIMPLE_NAME $ENTRY_POINT $PACKAGE_NAME $ROOT_PATH &
PIDS+=($!)
else
generate_docs $SIMPLE_NAME $ENTRY_POINT $PACKAGE_NAME $ROOT_PATH
PIDS+=($!)
fi
echo -e $!
done
# wait for all pids
for pid in ${PIDS[*]}
do
echo -e "Waiting on: $pid"
wait $pid
done
# --- SEO/AEO head metadata post-pass --------------------------------------
# TypeDoc's default theme is used as-is in this repo (no editable .hbs
# templates to hook into), so the fix runs as a post-process over the
# already-generated HTML instead of a template change.
# Runs over the whole OUTDIR so it covers every package generated above.
echo -e "\033[0;93mInjecting SEO head metadata (canonical, per-page description, JSON-LD)\033[0m"
python3 "${SCRIPT_DIR}/typedoc_seo_postprocess.py" \
"${OUTDIR}" \
"https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi"
echo "Done"