1
0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-12-22 12:23:56 +01:00
qmckl/tools/build_doc.sh
2022-12-08 18:34:32 +01:00

63 lines
1.4 KiB
Bash
Executable File

#!/bin/bash
# Extracts documentation from an org-mode file.
# Check required environment variables
# ------------------------------------
if [[ -z ${srcdir} ]] ; then
echo "Error: srcdir environment variable is not defined"
exit 1
fi
readonly DOCS=share/doc/qmckl/
readonly ORG=${srcdir}/org/
readonly HTMLIZE=${DOCS}/html/htmlize.el
readonly CONFIG_DOC=${srcdir}/tools/config_doc.el
readonly CONFIG_TANGLE=${srcdir}/tools/config_tangle.el
function extract_doc()
{
org=$1
local_html=${org%.org}.html
local_text=${org%.org}.txt
html=${DOCS}/html/$(basename ${org%.org}.html)
text=${DOCS}/text/$(basename ${org%.org}.txt)
${srcdir}/tools/missing \
emacs --no-init-file --no-site-lisp --quick --batch \
--load="${HTMLIZE}" \
--load="${CONFIG_DOC}" \
${org} \
--load="${CONFIG_TANGLE}" \
-f org-html-export-to-html \
-f org-ascii-export-to-ascii
rc=$?
if [ $rc -ne 0 ] ; then
return $rc
fi
mv ${local_html} ${html}
mv ${local_text} ${text}
}
for i in $@
do
exported=${i%.org}.exported
exported=${srcdir}/src/$(basename $exported)
NOW=$(date +"%m%d%H%M.%S")
extract_doc ${i} &> $exported
rc=$?
# Make log file older than the exported files
touch -t ${NOW} $exported
# Fail if tangling failed
if [ $rc -ne 0 ] ; then
cat $exported
rm $exported
exit $rc
fi
done