aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/doc_gen/run_doc.sh
blob: 10cc3e249dd00dc99d92b33eb72961924c4527b9 (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
#!/bin/bash

WORKING_DIR='tmp'
BUILD_DIR='_build'

# Clean-up when finished:
trap 'rm -rf ${WORKING_DIR}; exit' EXIT
trap 'rm -rf ${WORKING_DIR}; exit' ERR

# Remove the old build:
rm -rf ${BUILD_DIR} || true
rm -rf ${WORKING_DIR} || true

# Create working directories
mkdir ${BUILD_DIR}
mkdir --parents ${WORKING_DIR}/resources/libraries/python/
mkdir --parents ${WORKING_DIR}/resources/libraries/robot/
mkdir --parents ${WORKING_DIR}/tests/

# Copy the Sphinx source files:
cp -r src/* ${WORKING_DIR}/

# Copy the source files to be processed:
from_dir="../../../resources/libraries/python/"
to_dir="${WORKING_DIR}/resources/libraries/python/"
command="rsync -a --include '*/'"
${command} --include '*.py' --exclude '*' "${from_dir}" "${to_dir}"
cp ../../../resources/__init__.py ${WORKING_DIR}/resources/
cp ../../../resources/libraries/__init__.py ${WORKING_DIR}/resources/libraries/
from_dir="../../../resources/libraries/robot/"
to_dir="${WORKING_DIR}/resources/libraries/robot/"
${command} --include '*.robot' --exclude '*' "${from_dir}" "${to_dir}"
from_dir="../../../tests/"
to_dir="${WORKING_DIR}/tests/"
${command} --include '*.robot' --exclude '*' "${from_dir}" "${to_dir}"

# Create virtual environment:
virtualenv --python=$(which python3) ${WORKING_DIR}/env
. ${WORKING_DIR}/env/bin/activate

# Install CSIT requirements:
pip3 install --upgrade -r ../../../requirements.txt

export PYTHONPATH=`pwd`

# Generate rst files:
python3 gen_rst.py

# Remove all rst files from ./${WORKING_DIR}/env directory - we do not need them
find ./${WORKING_DIR}/env -type f -name '*.rst' | xargs rm -f

# Generate the documentation:
DATE=$(date -u '+%d-%b-%Y')
command="sphinx-build -v -c '${WORKING_DIR}' -a  -b html -E -D release='$1' -D"
command+=" version='$1 documentation - $DATE' '${WORKING_DIR}' '${BUILD_DIR}/'"
${command}

find . -type d -name 'env' | xargs rm -rf

echo Creating csit.doc.tar.gz ...
tar -czvf ./csit.docs.tar.gz ${BUILD_DIR}