diff options
Diffstat (limited to 'util/generate_api_docs.sh')
| -rwxr-xr-x | util/generate_api_docs.sh | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/util/generate_api_docs.sh b/util/generate_api_docs.sh new file mode 100755 index 000000000..8d7ec3101 --- /dev/null +++ b/util/generate_api_docs.sh | |||
| @@ -0,0 +1,31 @@ | |||
| 1 | #!/bin/bash | ||
| 2 | |||
| 3 | set -x | ||
| 4 | |||
| 5 | if ! doxygen -v 2>&1 > /dev/null; then | ||
| 6 | echo "doxygen not found! Please install it!" | ||
| 7 | exit 1 | ||
| 8 | elif ! moxygen -V 2>&1 > /dev/null; then | ||
| 9 | echo -n "moxygen not found! Would you like to install it? [y/n] " | ||
| 10 | read ANSWER | ||
| 11 | case $ANSWER in | ||
| 12 | y|Y|yes|YES|Yes) | ||
| 13 | npm install -g moxygen | ||
| 14 | ;; | ||
| 15 | *) | ||
| 16 | exit 1 | ||
| 17 | ;; | ||
| 18 | esac | ||
| 19 | fi | ||
| 20 | |||
| 21 | if [ ! -e Doxyfile ]; then | ||
| 22 | echo "Error: You must run this from the top-level qmk_firmware directory!" | ||
| 23 | exit 1 | ||
| 24 | fi | ||
| 25 | |||
| 26 | # Generate the doxygen XML files | ||
| 27 | rm -rf doxygen | ||
| 28 | doxygen Doxyfile | ||
| 29 | |||
| 30 | # Generate the moxygen Markdown files | ||
| 31 | moxygen -a -g -o docs/api_%s.md doxygen/xml | ||
