Doxygen Documentation

.github/workflows/docs.yml

@@ -5,52 +5,60 @@
 # https://www.boost.org/LICENSE_1_0.txt
 #
 
-name: Docs Generator
+name: Publish Docs
 
-on: push
+on:
+  push:
+    branches:
+      - master
 
 jobs:
   generateDOC:
-    name: Docs Generator
-    runs-on: ubuntu-20.04
+    name: Publish Docs
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Generate Table of Contents
-        uses: technote-space/toc-generator@v2
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          MAX_HEADER_LEVEL: 3
-          FOLDING: true
       - name: Update Contributors
-        if: github.ref == 'refs/heads/master'
-        uses: akhilmhdh/[email protected]
+        uses: akhilmhdh/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           image_size: 100
           columns_per_row: 6
-      - name: Download mdsplit
+          readme_path: docs/acknowledgments.md
+        continue-on-error: true
+      - name: Install doxygen
+        run: sudo apt-get install doxygen
+      - name: Generate doxygen XML
+        run: doxygen
+        working-directory: ./docs
+      - name: Download doxybook2
         uses: carlosperate/[email protected]
-        id: download-mdsplit
+        id: download-doxybook2
         with:
-          file-url: 'https://github.com/alandefreitas/mdsplit/releases/download/v0.1.1/Executable.Linux.zip'
-          file-name: 'mdsplit.zip'
-          location: '.'
-      - name: Unzip mdsplit
+          file-url: 'https://github.com/matusnovak/doxybook2/releases/download/v1.4.0/doxybook2-linux-amd64-v1.4.0.zip'
+          file-name: 'doxybook2.zip'
+          location: './docs'
+      - name: Unzip doxybook2
         run: |
-          unzip mdsplit.zip
-          rm -f mdsplit.zip
-          sudo chmod +x mdsplit
+          unzip doxybook2.zip
+          rm -f doxybook2.zip
+          sudo chmod +x ./bin/doxybook2
+          mkdir reference
           ls
-      - name: Generate Documentation Source
-        run: ./mdsplit -r alandefreitas/small
+        working-directory: ./docs
+      - name: Generate Doxybook
+        run: ./bin/doxybook2 --input ./xml --output reference --config .doxybook/config.json --templates .doxybook/templates
+        working-directory: ./docs
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
           python-version: 3.x
       - name: Install Mkdocs Material
         run: pip install mkdocs-material
-      - name: Install Awesome Pages Plugin # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
-        run: pip install mkdocs-awesome-pages-plugin
+      - name: Install Mermaid for Mkdocs
+        run: pip install mkdocs-mermaid2-plugin
+      - name: Install Macros for Mkdocs
+        run: pip install mkdocs-macros-plugin
       - name: Deploy mkdocs to gh-pages branch
-        run: mkdocs gh-deploy --force
+        run: mkdocs gh-deploy --force