Merge pull request #734 from riri/master

Restore documentation on github pages with Doxygen generated doc

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Documentation on github.io
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+    - name: apt-update
+      run: sudo apt-get update -qq
+    - name: apt-get doxygen
+      run: sudo apt-get install -y doxygen
+    - name: build doc
+      run: make docs
+    - name: deploy
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./doc/html/
+        enable_jekyll: false
+        allow_empty_commit: false
+        force_orphan: true

Readme.md

@@ -25,7 +25,7 @@ render backends, it focuses only on the actual UI.
 - No global or hidden state
 - Customizable library modules (you can compile and use only what you need)
 - Optional font baker and vertex buffer output
-- [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/doc/nuklear.html)
+- [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/)
 
 ## Building
 

doc/Doxyfile

@@ -907,8 +907,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  =    "./src" \
-                            "./src/HEADER.md" \
-                            "./Readme.md"
+                            "./src/HEADER.md"
 
 
 
@@ -1001,7 +1000,7 @@ RECURSIVE              = NO
 
 EXCLUDE                = "./src/Readme.md" \
                             "./src/paq.sh" \
-                            "./src/paq.bat" 
+                            "./src/paq.bat"
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1110,7 +1109,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = Readme.md
+USE_MDFILE_AS_MAINPAGE = src/HEADER.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing