diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2018-03-26 20:24:30 +0200 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2018-03-26 20:43:37 +0200 |
| commit | ae7284edb8bd8ed7fcab29415049bf03baf57f8d (patch) | |
| tree | b03927f750f03239a8e01837e29e8374dcd3ec1d /util/generate_internal_docs.sh | |
| parent | 66162b2b681de37dd0aa34f3b6527a5292ab1560 (diff) | |
| download | qmk_firmware-ae7284edb8bd8ed7fcab29415049bf03baf57f8d.tar.gz qmk_firmware-ae7284edb8bd8ed7fcab29415049bf03baf57f8d.tar.xz | |
rename api docs to internals
Diffstat (limited to 'util/generate_internal_docs.sh')
| -rw-r--r-- | util/generate_internal_docs.sh | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/util/generate_internal_docs.sh b/util/generate_internal_docs.sh new file mode 100644 index 000000000..bfee797d3 --- /dev/null +++ b/util/generate_internal_docs.sh @@ -0,0 +1,31 @@ +#!/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 |