Merge pull request #11 from microdee/feature/doxygen

Port docs to Doxygen

Author: microdee

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: [ microdee ]
+ko_fi: microdee
+thanks_dev: microdee

.github/workflows/doxygen.yml

@@ -0,0 +1,27 @@
+on:
+  push:
+    branches:
+      - main
+      - gh-actions-test
+    tags:
+      - generate-docs
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Doxygen on GitHub Pages
+        id: ghaction
+        uses: AgarwalSaurav/ghaction-doxygen-ghpages@de7725119570b5d09a5d7872518f9e5cbd8dae8e
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          working-directory: .
+          doxyfile-path: docs/Doxyfile
+          html-output-folder: docs/Doxygen/html
+          branch: gh-pages

.gitignore

@@ -350,3 +350,4 @@ MigrationBackup/
 .ionide/
 /build/clang_tidy
 **/.nuke/temp/
+/.idea

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/DoxygenAwesome"]
+	path = docs/DoxygenAwesome
+	url = https://github.com/jothepro/doxygen-awesome-css.git

README.md

@@ -1,12 +1,18 @@
 <div align="center">
 
-<img width="400px" src="docs/nuke.cola.text.onLight.svg#gh-light-mode-only" />
-<img width="400px" src="docs/nuke.cola.text.onDark.svg#gh-dark-mode-only" />
+<img width="400px" src="docs/Images/nuke.cola.text.onLight.svg#gh-light-mode-only" />
+<img width="400px" src="docs/Images/nuke.cola.text.onDark.svg#gh-dark-mode-only" />
 
 Utilities and extensions useful for any Nuke builds originally separated from Nuke.Unreal.
 
+### [Documentation](https://mcro.de/md.Nuke.Cola)
+
 </div>
 
+### This README file is now deprecated
+> [!IMPORTANT]
+> Documentation is migrated over to https://mcro.de/md.Nuke.Cola which is nicer than this readme file. This README is now deprecated and won't be updated. However external links may direct to this README file. For this reason its contents of will be kept until October 2026.
+
 - [Build Plugins](#build-plugins)
   - [`[ImplicitBuildInterface]` plugins](#implicitbuildinterface-plugins)
   - [`*.nuke.csx` C# script plugins](#nukecsx-c-script-plugins)
@@ -495,9 +501,12 @@ Arguments.GetBlock("extra"); //-> ["extra", "arguments"]
 Arguments.GetBlock("foo"); //-> ["/foo", "--bar"]
 ```
 
+> [!IMPORTANT]
+> Documentation is migrated over to https://mcro.de/md.Nuke.Cola which is nicer than this readme file. This README is now deprecated and won't be updated. However external links may direct to this README file. For this reason its contents of will be kept until October 2026.
+
 <div align="center">
 
-<img width="400px" src="docs/nuke.cola.full.onLight.svg#gh-light-mode-only" />
-<img width="400px" src="docs/nuke.cola.full.onDark.svg#gh-dark-mode-only" />
+<img width="400px" src="docs/Images/nuke.cola.full.onLight.svg#gh-light-mode-only" />
+<img width="400px" src="docs/Images/nuke.cola.full.onDark.svg#gh-dark-mode-only" />
 
 </div>

docs/.gitignore

@@ -0,0 +1 @@
+Doxygen