rename api docs to internals
This commit is contained in:
		
							parent
							
								
									66162b2b68
								
							
						
					
					
						commit
						ae7284edb8
					
				@ -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)
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										2
									
								
								util/generate_api_docs.sh → util/generate_internal_docs.sh
									
									
									
									
									
										
										
										Executable file → Normal file
									
								
							
							
						
						
									
										2
									
								
								util/generate_api_docs.sh → util/generate_internal_docs.sh
									
									
									
									
									
										
										
										Executable file → Normal file
									
								
							@ -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
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user