forked from thesofproject/sof
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgen-doc.sh
More file actions
executable file
·143 lines (120 loc) · 2.84 KB
/
gen-doc.sh
File metadata and controls
executable file
·143 lines (120 loc) · 2.84 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
#!/bin/bash
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2019 Intel Corporation. All rights reserved.
# SOF documentation building & publishing.
# According to instructions:
# https://thesofproject.github.io/latest/howtos/process/docbuild.html
# fail immediately on any errors
set -e
function print_usage()
{
echo "usage: $0 <-b|-c|-p> [-r]"
echo " [-b] Build"
echo " [-c] Clean"
echo " [-p] Publish"
echo " [-r] Fetch missing repositories"
}
# make it runnable from any location
# user shouldn't be confused from which dir this script has to be run
SCRIPT_DIR=$(cd "$(dirname "$0")" && pwd)
# expected paths of repositories needed for documentation process
SOF_REPO=$(dirname "$SCRIPT_DIR")
DOCS_REPO="$(dirname "$SOF_REPO")/sof-docs"
PUBLISH_REPO="$(dirname "$SOF_REPO")/thesofproject.github.io"
# parse arguments
DO_BUILD=no
DO_CLEAN=no
DO_PUBLISH=no
DO_CLONE=no
for args in $@
do
if [[ "$args" == "-b" ]]
then
DO_BUILD=yes
elif [[ "$args" == "-c" ]]
then
DO_CLEAN=yes
elif [[ "$args" == "-p" ]]
then
DO_PUBLISH=yes
elif [[ "$args" == "-r" ]]
then
DO_CLONE=yes
fi
done
if [ "x$DO_BUILD" == "xno" ] && \
[ "x$DO_CLEAN" == "xno" ] && \
[ "x$DO_PUBLISH" == "xno" ]
then
print_usage
exit 1
fi
if [ ! -d "$DOCS_REPO" ]
then
if [ "x$DO_CLONE" == "xyes" ]
then
echo "No sof-docs repo at: $DOCS_REPO"
echo "Cloning sof-docs repo"
read -p 'Enter your GitHub user name: ' GITHUB_USER
git clone \
git@github.com:$GITHUB_USER/sof-docs.git \
"$DOCS_REPO"
# set up fork for upstreaming, just like in instructions
cd "$DOCS_REPO"
git remote add upstream git@github.com:thesofproject/sof-docs.git
else
echo "Error: No sof-docs repo at: $DOCS_REPO"
echo "You can rerun the script with -r argument to fetch missing repositories:"
echo "Example: $0 $@ -r"
exit 1
fi
fi
cd "$SOF_REPO/doc"
if [ "x$DO_CLEAN" == "xyes" ]
then
echo "Cleaning $SOF_REPO"
cmake .
make clean
make doc-clean
fi
if [ "x$DO_BUILD" == "xyes" ]
then
echo "Building $SOF_REPO"
cmake .
make doc
fi
cd "$DOCS_REPO"
if [ "x$DO_CLEAN" == "xyes" ]
then
echo "Cleaning $DOCS_REPO"
make clean
fi
if [ "x$DO_BUILD" == "xyes" ]
then
echo "Building $DOCS_REPO"
make html
echo "Documentation build finished"
echo "It can be viewed at: $DOCS_REPO/_build/html/index.html"
fi
if [ "x$DO_PUBLISH" == "xyes" ]
then
if [ ! -d "$PUBLISH_REPO" ]
then
if [ "x$DO_CLONE" == "xyes" ]
then
echo "No publishing repo at: $PUBLISH_REPO"
echo "Cloning thesofproject.github.io.git repo"
git clone \
git@github.com:thesofproject/thesofproject.github.io.git \
"$PUBLISH_REPO"
else
echo "Error: No publishing repo at: $PUBLISH_REPO"
echo "You can rerun the script with -r argument to fetch missing repositories:"
echo "Example: $0 $@ -r"
exit 1
fi
fi
echo "Publishing $PUBLISH_REPO"
cd "$DOCS_REPO"
make publish
fi