Browse Source

rename api docs to internals

pjones-keymap
Jack Humbert 1 year ago
parent
commit
ae7284edb8

+ 8
- 8
docs/_summary.md View File

@@ -88,11 +88,11 @@
88 88
 * Other Topics
89 89
   * [Using Eclipse with QMK](eclipse.md)
90 90
 
91
-* QMK API (In Progress)
92
-  * [Defines](api_defines.md)
93
-  * [Input Callback Reg](api_input_callback_reg.md)
94
-  * [Midi Device](api_midi_device.md)
95
-  * [Midi Device Setup Process](api_midi_device_setup_process.md)
96
-  * [Midi Util](api_midi_util.md)
97
-  * [Send Functions](api_send_functions.md)
98
-  * [Sysex Tools](api_sysex_tools.md)
91
+* QMK Internals (In Progress)
92
+  * [Defines](internals_defines.md)
93
+  * [Input Callback Reg](internals_input_callback_reg.md)
94
+  * [Midi Device](internals_midi_device.md)
95
+  * [Midi Device Setup Process](internals_midi_device_setup_process.md)
96
+  * [Midi Util](internals_midi_util.md)
97
+  * [Send Functions](internals_send_functions.md)
98
+  * [Sysex Tools](internals_sysex_tools.md)

docs/api_defines.md → docs/internals_defines.md View File


docs/api_input_callback_reg.md → docs/internals_input_callback_reg.md View File


docs/api_midi_device.md → docs/internals_midi_device.md View File


docs/api_midi_device_setup_process.md → docs/internals_midi_device_setup_process.md View File


docs/api_midi_util.md → docs/internals_midi_util.md View File


docs/api_send_functions.md → docs/internals_send_functions.md View File


docs/api_sysex_tools.md → docs/internals_sysex_tools.md View File


util/generate_api_docs.sh → util/generate_internal_docs.sh View File

@@ -28,4 +28,4 @@ rm -rf doxygen
28 28
 doxygen Doxyfile
29 29
 
30 30
 # Generate the moxygen Markdown files
31
-moxygen -a -g -o docs/api_%s.md doxygen/xml
31
+moxygen -a -g -o docs/internals_%s.md doxygen/xml

+ 5
- 5
util/travis_docs.sh View File

@@ -3,12 +3,12 @@
3 3
 source util/travis_push.sh
4 4
 
5 5
 if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then 
6
-	if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/api_.*'; then
7
-		echo "Generating API docs..."
6
+	if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/internals_.*'; then
7
+		echo "Generating internal docs..."
8 8
 		rm -rf doxygen
9 9
 		doxygen Doxyfile
10
-		moxygen -q -a -g -o docs/api_%s.md doxygen/xml
11
-		git add docs/api_*
12
-		git commit -m'autogenerated api docs for ${TRAVIS_COMMIT_RANGE}' || true
10
+		moxygen -q -a -g -o docs/internals_%s.md doxygen/xml
11
+		git add docs/internals_*
12
+		git commit -m'autogenerated internal docs for ${TRAVIS_COMMIT_RANGE}' || true
13 13
 	fi
14 14
 fi

Loading…
Cancel
Save