blob: 68c6c96a6c4e6a2fdf8e112e04a3f857d1bed835 (
plain)
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
|
#!/bin/bash
# SPDX-license-identifier: Apache-2.0
##############################################################################
# Copyright (c) 2016 NEC and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
set -o errexit
set -o nounset
set -o pipefail
set -o xtrace
GIT_CLONE_BASE=${GIT_CLONE_BASE:-ssh://gerrit.opnfv.org:29418}
GERRIT_BRANCH=${GERRIT_BRANCH:-master}
WORKSPACE=${WORKSPACE:-/tmp}
get_repo_names() {
# NOTE: Not all repositories are ready for the composite docs,
# so we have the repo name list here to add project docs
# one by one. This will be replaced by the list in project.cfg .
# grep -v '^#' releng/jjb/opnfvdocs/project.cfg | sort
echo "sdnvpn"
echo "fuel"
echo "ipv6"
echo "joid"
echo "functest"
echo "apex"
echo "promise"
echo "copper"
echo "doctor"
echo "vswitchperf"
echo "fastpathmetrics"
}
git_clone() {
_repo="$1"
[[ -d "$WORKSPACE/$_repo" ]] && return 0
pushd $WORKSPACE
git clone -b $GERRIT_BRANCH --depth 1 --quiet $GIT_CLONE_BASE/$_repo
popd
}
git_clone releng
repos=$(get_repo_names)
[[ -e docs/projects ]] && rm -rf docs/projects
mkdir -p docs/projects
echo
echo "Cloning repos of participating OPNFV Projects and copying docs"
echo
for repo in $repos; do
echo " $repo ($GERRIT_BRANCH)"
git_clone $repo
[[ -e $WORKSPACE/$repo/docs ]] || continue
[[ -e docs/projects/$repo ]] && rm -rf docs/projects/$repo
cp -r $WORKSPACE/$repo/docs docs/projects/$repo
# Replace PATH variables by source file folder paths.
# Note: Editors can recognize as follows:
# * @PROJECT_PATH@ is pointer to the project folder
# 'opnfvdocs/docs/projects/<project name>'.
# * @OPNFVDOCS_PATH@ is pointer to the main folder 'opnfvdocs/docs'.
# Note: 'docs_build/_src' is the folder in which all document contents
# will be copied during docs build process.
find docs/projects/$repo -type f -name '*.rst' -print | \
xargs -I f sed -i \
-e "s|@PROJECT_PATH@|docs_build/_src/projects/$repo|" \
-e "s|@OPNFVDOCS_PATH@|docs_build/_src|" f
done
# NOTE: Removing index.rst in project repos to reduce number of docs.
find docs/projects -type f -name 'index.rst' -print | xargs -I i rm -f i
# NOTE: automated link generation is not ready...
echo
echo "Creating document links"
echo
targets="
configguide/installer-config.rst
configguide/feature-config.rst
userguide/test-usage.rst
userguide/feature-usage.rst
"
# configguide/post-install.rst
for guide in $targets
do
mainfile="$WORKSPACE/docs/$guide"
for repo in $repos
do
projectfile="projects/$repo/${guide//-/}"
projectlink="${mainfile%/*}/featureconfig-$repo.rst"
[[ -e "$WORKSPACE/docs/$projectfile" ]] || continue
echo "Adding $repo to $guide ..."
echo "" >> $mainfile
echo ".. toctree::" >> $mainfile
echo "" >> $mainfile
echo " $projectlink" >> $mainfile
echo ".. include:: ../$projectfile" >> $projectlink
done
echo
echo "Generated $guide:"
cat $mainfile
echo
done
$WORKSPACE/releng/utils/docs-build.sh
echo "Done"
|
