diff options
| -rw-r--r-- | docs/_summary.md | 16 | ||||
| -rw-r--r-- | docs/internals_defines.md (renamed from docs/api_defines.md) | 0 | ||||
| -rw-r--r-- | docs/internals_input_callback_reg.md (renamed from docs/api_input_callback_reg.md) | 0 | ||||
| -rw-r--r-- | docs/internals_midi_device.md (renamed from docs/api_midi_device.md) | 0 | ||||
| -rw-r--r-- | docs/internals_midi_device_setup_process.md (renamed from docs/api_midi_device_setup_process.md) | 0 | ||||
| -rw-r--r-- | docs/internals_midi_util.md (renamed from docs/api_midi_util.md) | 0 | ||||
| -rw-r--r-- | docs/internals_send_functions.md (renamed from docs/api_send_functions.md) | 0 | ||||
| -rw-r--r-- | docs/internals_sysex_tools.md (renamed from docs/api_sysex_tools.md) | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | util/generate_internal_docs.sh (renamed from util/generate_api_docs.sh) | 2 | ||||
| -rw-r--r-- | util/travis_docs.sh | 10 |
10 files changed, 14 insertions, 14 deletions
diff --git a/docs/_summary.md b/docs/_summary.md index e7a32959e8..318c526a85 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 index fdcb553589..fdcb553589 100644 --- a/docs/api_defines.md +++ b/docs/internals_defines.md diff --git a/docs/api_input_callback_reg.md b/docs/internals_input_callback_reg.md index 4ea132a83a..4ea132a83a 100644 --- a/docs/api_input_callback_reg.md +++ b/docs/internals_input_callback_reg.md diff --git a/docs/api_midi_device.md b/docs/internals_midi_device.md index 5b57abd454..5b57abd454 100644 --- a/docs/api_midi_device.md +++ b/docs/internals_midi_device.md diff --git a/docs/api_midi_device_setup_process.md b/docs/internals_midi_device_setup_process.md index ae82197c5c..ae82197c5c 100644 --- a/docs/api_midi_device_setup_process.md +++ b/docs/internals_midi_device_setup_process.md diff --git a/docs/api_midi_util.md b/docs/internals_midi_util.md index 97821bd180..97821bd180 100644 --- a/docs/api_midi_util.md +++ b/docs/internals_midi_util.md diff --git a/docs/api_send_functions.md b/docs/internals_send_functions.md index b331508008..b331508008 100644 --- a/docs/api_send_functions.md +++ b/docs/internals_send_functions.md diff --git a/docs/api_sysex_tools.md b/docs/internals_sysex_tools.md index 55dbe9e164..55dbe9e164 100644 --- a/docs/api_sysex_tools.md +++ b/docs/internals_sysex_tools.md diff --git a/util/generate_api_docs.sh b/util/generate_internal_docs.sh index 8d7ec3101f..bfee797d3a 100755..100644 --- 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 74eee3c267..5cfd63466d 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 |