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: [PATCH] rename api docs to internals

---
 docs/_summary.md                                 | 16 ++++++++--------
 docs/{api_defines.md => internals_defines.md}    |  0
 ...ck_reg.md => internals_input_callback_reg.md} |  0
 ...i_midi_device.md => internals_midi_device.md} |  0
 ...md => internals_midi_device_setup_process.md} |  0
 .../{api_midi_util.md => internals_midi_util.md} |  0
 ..._functions.md => internals_send_functions.md} |  0
 ...i_sysex_tools.md => internals_sysex_tools.md} |  0
 ...ate_api_docs.sh => generate_internal_docs.sh} |  2 +-
 util/travis_docs.sh                              | 10 +++++-----
 10 files changed, 14 insertions(+), 14 deletions(-)
 rename docs/{api_defines.md => internals_defines.md} (100%)
 rename docs/{api_input_callback_reg.md => internals_input_callback_reg.md} (100%)
 rename docs/{api_midi_device.md => internals_midi_device.md} (100%)
 rename docs/{api_midi_device_setup_process.md => internals_midi_device_setup_process.md} (100%)
 rename docs/{api_midi_util.md => internals_midi_util.md} (100%)
 rename docs/{api_send_functions.md => internals_send_functions.md} (100%)
 rename docs/{api_sysex_tools.md => internals_sysex_tools.md} (100%)
 rename util/{generate_api_docs.sh => generate_internal_docs.sh} (91%)
 mode change 100755 => 100644

diff --git a/docs/_summary.md b/docs/_summary.md
index e7a32959e..318c526a8 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -88,11 +88,11 @@
 * Other Topics
   * [Using Eclipse with QMK](eclipse.md)
 
-* QMK API (In Progress)
-  * [Defines](api_defines.md)
-  * [Input Callback Reg](api_input_callback_reg.md)
-  * [Midi Device](api_midi_device.md)
-  * [Midi Device Setup Process](api_midi_device_setup_process.md)
-  * [Midi Util](api_midi_util.md)
-  * [Send Functions](api_send_functions.md)
-  * [Sysex Tools](api_sysex_tools.md)
+* QMK Internals (In Progress)
+  * [Defines](internals_defines.md)
+  * [Input Callback Reg](internals_input_callback_reg.md)
+  * [Midi Device](internals_midi_device.md)
+  * [Midi Device Setup Process](internals_midi_device_setup_process.md)
+  * [Midi Util](internals_midi_util.md)
+  * [Send Functions](internals_send_functions.md)
+  * [Sysex Tools](internals_sysex_tools.md)
diff --git a/docs/api_defines.md b/docs/internals_defines.md
similarity index 100%
rename from docs/api_defines.md
rename to docs/internals_defines.md
diff --git a/docs/api_input_callback_reg.md b/docs/internals_input_callback_reg.md
similarity index 100%
rename from docs/api_input_callback_reg.md
rename to docs/internals_input_callback_reg.md
diff --git a/docs/api_midi_device.md b/docs/internals_midi_device.md
similarity index 100%
rename from docs/api_midi_device.md
rename to docs/internals_midi_device.md
diff --git a/docs/api_midi_device_setup_process.md b/docs/internals_midi_device_setup_process.md
similarity index 100%
rename from docs/api_midi_device_setup_process.md
rename to docs/internals_midi_device_setup_process.md
diff --git a/docs/api_midi_util.md b/docs/internals_midi_util.md
similarity index 100%
rename from docs/api_midi_util.md
rename to docs/internals_midi_util.md
diff --git a/docs/api_send_functions.md b/docs/internals_send_functions.md
similarity index 100%
rename from docs/api_send_functions.md
rename to docs/internals_send_functions.md
diff --git a/docs/api_sysex_tools.md b/docs/internals_sysex_tools.md
similarity index 100%
rename from docs/api_sysex_tools.md
rename to docs/internals_sysex_tools.md
diff --git a/util/generate_api_docs.sh b/util/generate_internal_docs.sh
old mode 100755
new mode 100644
similarity index 91%
rename from util/generate_api_docs.sh
rename to util/generate_internal_docs.sh
index 8d7ec3101..bfee797d3
--- a/util/generate_api_docs.sh
+++ b/util/generate_internal_docs.sh
@@ -28,4 +28,4 @@ rm -rf doxygen
 doxygen Doxyfile
 
 # Generate the moxygen Markdown files
-moxygen -a -g -o docs/api_%s.md doxygen/xml
+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