-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgenerate_docs.sh
More file actions
executable file
·180 lines (152 loc) · 3.35 KB
/
generate_docs.sh
File metadata and controls
executable file
·180 lines (152 loc) · 3.35 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
#!/usr/bin/env bash
set -euo pipefail
function assert_defined(){
if [[ -z "${!1}" ]]; then
>&2 echo "Variable '${1}' must be defined"
exit 1
fi
}
function gen_cpp() {
local -r IMAGE="or-tools/docs:cpp"
docker build \
--tag ${IMAGE} \
--target=cpp \
-f "${ROOT_DIR}/src/Dockerfile" \
"${ROOT_DIR}/src"
rm -rf "${OUTPUT_DIR}"/cpp
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name cpp_doc \
${IMAGE} \
"cp -r build/docs/cpp /export/"
}
function gen_dotnet() {
local -r IMAGE="or-tools/docs:dotnet"
docker build \
--tag ${IMAGE} \
--target=dotnet \
-f "${ROOT_DIR}/src/Dockerfile" \
"${ROOT_DIR}/src"
rm -rf "${OUTPUT_DIR}"/dotnet
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name dotnet_doc \
${IMAGE} \
"cp -r build/docs/dotnet /export/"
}
function gen_java() {
local -r IMAGE="or-tools/docs:java"
docker build \
--tag ${IMAGE} \
--target=java \
-f "${ROOT_DIR}/src/Dockerfile" \
"${ROOT_DIR}/src"
rm -rf "${OUTPUT_DIR}"/java
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name java_doc \
${IMAGE} \
"cp -r build/docs/java /export/"
rm -rf "${OUTPUT_DIR}"/javadoc
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name javadoc_doc \
${IMAGE} \
"cp -r build/docs/javadoc /export/"
}
function gen_python() {
local -r IMAGE="or-tools/docs:python"
docker build \
--tag ${IMAGE} \
--target=python \
-f "${ROOT_DIR}/src/Dockerfile" \
"${ROOT_DIR}/src"
rm -rf "${OUTPUT_DIR}"/python
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name python_doc \
${IMAGE} \
"cp -r build/docs/python /export/"
rm -rf "${OUTPUT_DIR}"/pdoc
docker run --rm --init \
-v "${OUTPUT_DIR}/":/export \
-it \
--user "${ID_U}":"${ID_G}" \
--name pdoc_doc \
${IMAGE} \
"cp -r build/docs/pdoc /export/"
}
function gen_all() {
gen_cpp
gen_dotnet
gen_java
gen_python
}
function usage() {
local -r NAME=$(basename "$0")
echo -e "$NAME - Build docs using an Alpine Docker.
SYNOPSIS
\t$NAME [-h|--help] [cpp|dotnet|java|python|all]
DESCRIPTION
\tBuild Google OR-Tools reference documentation using an alpine distro.
OPTIONS
\t-h --help: show this help text
\tcpp: Build the C++ doc only
\tdotnet: Build the .Net doc only
\tjava: Build the Java doc only
\tpython: Build the Python doc only
\tall: Build all docs (default)
EXAMPLES
$0 all"
}
# Main
function main() {
case ${1} in
cpp | dotnet | java | python | all) ;;
-h | --help | *)
usage; exit ;;
esac
# log all cmd
set -x
set -x
# shellcheck disable=SC2155
declare -r ROOT_DIR="$(cd -P -- "$(dirname -- "$0")" && pwd -P)"
declare -r OUTPUT_DIR="${ROOT_DIR}/docs"
declare -r ID_U="$(id -u)"
declare -r ID_G="$(id -g)"
echo "Root dir: '${ROOT_DIR}'"
echo "Output dir: '${OUTPUT_DIR}'"
rm -rf "${OUTPUT_DIR}"/assets
mkdir -pv "${OUTPUT_DIR}"/assets/img/
cp src/logo.png "${OUTPUT_DIR}"/assets/img/
cp src/_config.yml "${OUTPUT_DIR}"/
cp src/index.md "${OUTPUT_DIR}"/
case ${1} in
cpp)
gen_cpp
exit ;;
dotnet)
gen_dotnet
exit ;;
java)
gen_java
exit ;;
python)
gen_python
exit ;;
all)
gen_all
exit ;;
esac
}
main "${1:-all}"