rename api docs to internals

neopostmodern · Mar 26, 2018 · ae7284e · ae7284e
1 parent 66162b2
commit ae7284e
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 14 deletions.
diff --git 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 → docs/internals_defines.md b/docs/api_defines.md → docs/internals_defines.md
diff --git a/docs/api_input_callback_reg.md → docs/internals_input_callback_reg.md b/docs/api_input_callback_reg.md → docs/internals_input_callback_reg.md
diff --git a/docs/api_midi_device.md → docs/internals_midi_device.md b/docs/api_midi_device.md → docs/internals_midi_device.md
diff --git a/docs/api_midi_device_setup_process.md → docs/internals_midi_device_setup_process.md b/docs/api_midi_device_setup_process.md → docs/internals_midi_device_setup_process.md
diff --git a/docs/api_midi_util.md → docs/internals_midi_util.md b/docs/api_midi_util.md → docs/internals_midi_util.md
diff --git a/docs/api_send_functions.md → docs/internals_send_functions.md b/docs/api_send_functions.md → docs/internals_send_functions.md
diff --git a/docs/api_sysex_tools.md → docs/internals_sysex_tools.md b/docs/api_sysex_tools.md → docs/internals_sysex_tools.md
diff --git a/util/generate_api_docs.sh → util/generate_internal_docs.sh b/util/generate_api_docs.sh → 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
@@ -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