mirror of https://github.com/zeldaret/tmc.git
				
				
				
			preliminary doxygen support
This commit is contained in:
		
							parent
							
								
									fb6d16f20d
								
							
						
					
					
						commit
						27ee1473ea
					
				| 
						 | 
					@ -0,0 +1,22 @@
 | 
				
			||||||
 | 
					name: run Doxygen to generate docs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					on:
 | 
				
			||||||
 | 
					  push:
 | 
				
			||||||
 | 
					    branches:
 | 
				
			||||||
 | 
					      - master
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					jobs:
 | 
				
			||||||
 | 
					  build:
 | 
				
			||||||
 | 
					    runs-on: ubuntu-latest
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    steps:
 | 
				
			||||||
 | 
					    - uses: actions/checkout@v2
 | 
				
			||||||
 | 
					    - name: generate docs
 | 
				
			||||||
 | 
					      uses: mattnotmitt/doxygen-action@v1
 | 
				
			||||||
 | 
					      with:
 | 
				
			||||||
 | 
					        doxyfile-path: 'Doxyfile'
 | 
				
			||||||
 | 
					    - name: deploy docs to github pages
 | 
				
			||||||
 | 
					      uses: peaceiris/actions-gh-pages@v3
 | 
				
			||||||
 | 
					      with:
 | 
				
			||||||
 | 
					        github_token: ${{ secrets.GITHUB_TOKEN }}
 | 
				
			||||||
 | 
					        publish_dir: ./docs/doxygen
 | 
				
			||||||
| 
						 | 
					@ -1,33 +1,64 @@
 | 
				
			||||||
 | 
					# build artifacts
 | 
				
			||||||
 | 
					src/*.s
 | 
				
			||||||
 | 
					build/
 | 
				
			||||||
 | 
					cmake-build-*
 | 
				
			||||||
 | 
					*.elf
 | 
				
			||||||
 | 
					*.exe
 | 
				
			||||||
 | 
					*.gba
 | 
				
			||||||
 | 
					*.i
 | 
				
			||||||
 | 
					*.o
 | 
				
			||||||
 | 
					*.map
 | 
				
			||||||
 | 
					*.pcm
 | 
				
			||||||
 | 
					sound/**/*.bin
 | 
				
			||||||
 | 
					sound/songs/midi/*.s
 | 
				
			||||||
 | 
					translations/*.bin
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# doxygen
 | 
				
			||||||
 | 
					docs/doxygen/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# tools
 | 
				
			||||||
 | 
					tools/agbcc
 | 
				
			||||||
 | 
					tools/binutils
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# scripts
 | 
				
			||||||
 | 
					*.py
 | 
				
			||||||
 | 
					*.pl
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# graphics
 | 
				
			||||||
*.1bpp
 | 
					*.1bpp
 | 
				
			||||||
*.4bpp
 | 
					*.4bpp
 | 
				
			||||||
*.8bpp
 | 
					*.8bpp
 | 
				
			||||||
*.DS_Store
 | 
					 | 
				
			||||||
*.bak
 | 
					 | 
				
			||||||
*.bat
 | 
					 | 
				
			||||||
*.diff
 | 
					 | 
				
			||||||
*.dump
 | 
					 | 
				
			||||||
*.elf
 | 
					 | 
				
			||||||
*.exe
 | 
					 | 
				
			||||||
*.fwjpnfont
 | 
					*.fwjpnfont
 | 
				
			||||||
*.gba
 | 
					 | 
				
			||||||
*.sgm
 | 
					*.sgm
 | 
				
			||||||
*.sa1
 | 
					*.sa1
 | 
				
			||||||
*.sg1
 | 
					*.sg1
 | 
				
			||||||
*.gbapal
 | 
					*.gbapal
 | 
				
			||||||
*.hwjpnfont
 | 
					*.hwjpnfont
 | 
				
			||||||
*.i
 | 
					*.latfont
 | 
				
			||||||
 | 
					*.lz
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# system files
 | 
				
			||||||
 | 
					*.DS_Store
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# IDE
 | 
				
			||||||
 | 
					.vscode/settings.json
 | 
				
			||||||
 | 
					.vscode/c_cpp_properties.json
 | 
				
			||||||
 | 
					.vscode/tasks.json
 | 
				
			||||||
 | 
					*.code-workspace
 | 
				
			||||||
 | 
					.idea/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# misc
 | 
				
			||||||
 | 
					.fuse_hidden*
 | 
				
			||||||
 | 
					*.bak
 | 
				
			||||||
 | 
					*.bat
 | 
				
			||||||
 | 
					*.diff
 | 
				
			||||||
 | 
					*.dump
 | 
				
			||||||
*.id0
 | 
					*.id0
 | 
				
			||||||
*.id1
 | 
					*.id1
 | 
				
			||||||
*.id2
 | 
					*.id2
 | 
				
			||||||
*.idb
 | 
					*.idb
 | 
				
			||||||
*.dmp
 | 
					*.dmp
 | 
				
			||||||
*.latfont
 | 
					 | 
				
			||||||
*.lz
 | 
					 | 
				
			||||||
*.map
 | 
					 | 
				
			||||||
*.nam
 | 
					*.nam
 | 
				
			||||||
*.o
 | 
					 | 
				
			||||||
*.pcm
 | 
					 | 
				
			||||||
*.pl
 | 
					 | 
				
			||||||
*.rl
 | 
					*.rl
 | 
				
			||||||
*.s.old
 | 
					*.s.old
 | 
				
			||||||
*.s.old2
 | 
					*.s.old2
 | 
				
			||||||
| 
						 | 
					@ -35,7 +66,6 @@
 | 
				
			||||||
*.swo
 | 
					*.swo
 | 
				
			||||||
*.swp
 | 
					*.swp
 | 
				
			||||||
*.til
 | 
					*.til
 | 
				
			||||||
*.code-workspace
 | 
					 | 
				
			||||||
*.ss1
 | 
					*.ss1
 | 
				
			||||||
*.ss2
 | 
					*.ss2
 | 
				
			||||||
*.ss3
 | 
					*.ss3
 | 
				
			||||||
| 
						 | 
					@ -45,27 +75,13 @@
 | 
				
			||||||
*.ss7
 | 
					*.ss7
 | 
				
			||||||
*.ss8
 | 
					*.ss8
 | 
				
			||||||
*.ss9
 | 
					*.ss9
 | 
				
			||||||
.fuse_hidden*
 | 
					 | 
				
			||||||
.idea/
 | 
					 | 
				
			||||||
Thumbs.db
 | 
					Thumbs.db
 | 
				
			||||||
build/
 | 
					 | 
				
			||||||
cmake-build-*
 | 
					 | 
				
			||||||
sound/**/*.bin
 | 
					 | 
				
			||||||
sound/songs/midi/*.s
 | 
					 | 
				
			||||||
src/*.s
 | 
					 | 
				
			||||||
tags
 | 
					tags
 | 
				
			||||||
tools/agbcc
 | 
					 | 
				
			||||||
tools/binutils
 | 
					 | 
				
			||||||
translations/*.bin
 | 
					 | 
				
			||||||
types_*.taghl
 | 
					types_*.taghl
 | 
				
			||||||
*.zip
 | 
					*.zip
 | 
				
			||||||
!calcrom.pl
 | 
					!calcrom.pl
 | 
				
			||||||
!sound/programmable_wave_samples/*.pcm
 | 
					!sound/programmable_wave_samples/*.pcm
 | 
				
			||||||
_Deparsed_XSubs.pm
 | 
					_Deparsed_XSubs.pm
 | 
				
			||||||
*.py
 | 
					 | 
				
			||||||
*.sna
 | 
					*.sna
 | 
				
			||||||
__pycache__
 | 
					__pycache__
 | 
				
			||||||
.vscode/settings.json
 | 
					 | 
				
			||||||
.vscode/c_cpp_properties.json
 | 
					 | 
				
			||||||
.vscode/tasks.json
 | 
					 | 
				
			||||||
Info.plist
 | 
					Info.plist
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue