| 1 |
#!/bin/bash -e |
| 2 |
# |
| 3 |
# Build a generic version of <Project>BuildReference for general |
| 4 |
# documentation. |
| 5 |
# |
| 6 |
# Run as: |
| 7 |
# |
| 8 |
# cd <this_dir>/ |
| 9 |
# ./create-build-ref.sh |
| 10 |
# |
| 11 |
# You can skip the final generation of the output HTML and other files by |
| 12 |
# calling: |
| 13 |
# |
| 14 |
# ./create-build-ref.sh --skip-final-generation |
| 15 |
# |
| 16 |
|
| 17 |
skip_final_generation=0 |
| 18 |
|
| 19 |
while (( "$#" )); do |
| 20 |
case "$1" in |
| 21 |
--skip-final-generation) |
| 22 |
skip_final_generation=1 |
| 23 |
shift |
| 24 |
;; |
| 25 |
*) |
| 26 |
echo "Error: The argument '$1' is not supported!" |
| 27 |
exit 1 |
| 28 |
;; |
| 29 |
esac |
| 30 |
done |
| 31 |
|
| 32 |
source ../utils/gen_doc_utils.sh |
| 33 |
|
| 34 |
generate_git_version_file |
| 35 |
|
| 36 |
if [[ "${skip_final_generation}" == "0" ]] ; then |
| 37 |
echo |
| 38 |
echo "Generating HTML and PDF files ..." |
| 39 |
echo |
| 40 |
make |
| 41 |
else |
| 42 |
echo |
| 43 |
echo "Only generating the file TribitsBuildReference.rst on request!" |
| 44 |
echo |
| 45 |
make TribitsBuildReference.rst |
| 46 |
fi |