0
0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-18 23:53:23 +00:00
qmk_firmware/util/generate_internal_docs.sh
2018-11-02 13:42:05 -04:00

32 lines
601 B
Bash
Executable File

#!/bin/bash
set -x
if ! doxygen -v 2>&1 > /dev/null; then
echo "doxygen not found! Please install it!"
exit 1
elif ! moxygen -V 2>&1 > /dev/null; then
echo -n "moxygen not found! Would you like to install it? [y/n] "
read ANSWER
case $ANSWER in
y|Y|yes|YES|Yes)
npm install -g moxygen
;;
*)
exit 1
;;
esac
fi
if [ ! -e Doxyfile ]; then
echo "Error: You must run this from the top-level qmk_firmware directory!"
exit 1
fi
# Generate the doxygen XML files
rm -rf doxygen
doxygen Doxyfile
# Generate the moxygen Markdown files
moxygen -a -g -o docs/internals_%s.md doxygen/xml