From ae7284edb8bd8ed7fcab29415049bf03baf57f8d Mon Sep 17 00:00:00 2001
From: Jack Humbert <jack.humb@gmail.com>
Date: Mon, 26 Mar 2018 14:24:30 -0400
Subject: rename api docs to internals

---
 util/generate_api_docs.sh      | 31 -------------------------------
 util/generate_internal_docs.sh | 31 +++++++++++++++++++++++++++++++
 util/travis_docs.sh            | 10 +++++-----
 3 files changed, 36 insertions(+), 36 deletions(-)
 delete mode 100755 util/generate_api_docs.sh
 create mode 100644 util/generate_internal_docs.sh

(limited to 'util')

diff --git a/util/generate_api_docs.sh b/util/generate_api_docs.sh
deleted file mode 100755
index 8d7ec3101..000000000
--- a/util/generate_api_docs.sh
+++ /dev/null
@@ -1,31 +0,0 @@
-#!/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/api_%s.md doxygen/xml
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
diff --git a/util/travis_docs.sh b/util/travis_docs.sh
index 74eee3c26..5cfd63466 100644
--- a/util/travis_docs.sh
+++ b/util/travis_docs.sh
@@ -3,12 +3,12 @@
 source util/travis_push.sh
 
 if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then 
-	if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/api_.*'; then
-		echo "Generating API docs..."
+	if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/internals_.*'; then
+		echo "Generating internal docs..."
 		rm -rf doxygen
 		doxygen Doxyfile
-		moxygen -q -a -g -o docs/api_%s.md doxygen/xml
-		git add docs/api_*
-		git commit -m'autogenerated api docs for ${TRAVIS_COMMIT_RANGE}' || true
+		moxygen -q -a -g -o docs/internals_%s.md doxygen/xml
+		git add docs/internals_*
+		git commit -m'autogenerated internal docs for ${TRAVIS_COMMIT_RANGE}' || true
 	fi
 fi
-- 
cgit v1.2.3