Generate Doxygen

.github/workflows/documentation.yml

@@ -0,0 +1,36 @@
+name: MaxOS
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build-os:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-20.04
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Generate Docs
+        run: |
+          make documentation
+
+      - name: Upload to branch
+        uses: s0/git-publish-subdir-action@develop
+        env:
+          REPO: self
+          BRANCH: docs
+          FOLDER: docs/doxy
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MESSAGE: "Build: ({sha}) {msg}"

Makefile

@@ -83,15 +83,22 @@ virtualbox: iso
 
 .PHONY: clean
 clean:
+	# Remove the kernel object files
 	rm -rf obj
 	rm -f maxOS.bin maxOS.sym maxOS.img
 
+	# Remove all files and folders in the docs/doxy folder except for the Doxyfile
+	cd docs/doxy && find . ! -name 'Doxyfile' -type f -exec rm -f {} +
+
 cross_compiler:
 	cd toolchain && ./make_cross_compiler.sh
 
 disk_img:
 	cd toolchain && ./create_disk_img.sh
 
+documentation:
+	cd toolchain && ./make_documentation.sh
+
 install_deps:
 	sudo apt-get update -y
 	sudo apt-get install -y grub-pc qemu-system-i386 gdb dosfstools bridge-utils xorriso