~ruther/qmk_firmware

ae7284edb8bd8ed7fcab29415049bf03baf57f8d — Jack Humbert 7 years ago 66162b2
rename api docs to internals
M docs/_summary.md => docs/_summary.md +8 -8
@@ 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)

R docs/api_defines.md => docs/internals_defines.md +0 -0
R docs/api_input_callback_reg.md => docs/internals_input_callback_reg.md +0 -0
R docs/api_midi_device.md => docs/internals_midi_device.md +0 -0
R docs/api_midi_device_setup_process.md => docs/internals_midi_device_setup_process.md +0 -0
R docs/api_midi_util.md => docs/internals_midi_util.md +0 -0
R docs/api_send_functions.md => docs/internals_send_functions.md +0 -0
R docs/api_sysex_tools.md => docs/internals_sysex_tools.md +0 -0
R util/generate_api_docs.sh => util/generate_internal_docs.sh +1 -1
@@ 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

M util/travis_docs.sh => util/travis_docs.sh +5 -5
@@ 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