test mkdocs material with doxybook2 to include doxygen generated docs

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ on:
   push:
     branches:
       - master # (2)!
-      - main
+
 jobs:
   deploy:
     runs-on: ubuntu-latest

.github/workflows/publish-docs.yml

@@ -0,0 +1,31 @@
+# Copyright 2020 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+name: publish-docs
+on:
+  push:
+    branches:
+    - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+    - uses: mattnotmitt/doxygen-action@v1
+      with:
+        working-directory: docs/
+    - name: Generate Doxygen Documentation
+      run: |
+        mkdir doxybook2; cd doxybook2
+        wget https://github.com/matusnovak/doxybook2/releases/download/v1.4.0/doxybook2-linux-amd64-v1.4.0.zip
+        unzip doxybook2-linux-amd64-v1.4.0.zip; cd ../
+        chmod +x doxybook2/bin/doxybook2
+        mkdir docs/docs
+        ./doxybook2/bin/doxybook2 --input docs/xml --output docs/docs --config docs/doxybook2.json
+        rm -rf doxybook2
+    - run: pip install -r docs/requirements.txt
+    - run: mkdocs gh-deploy --force

.gitignore

@@ -12,7 +12,9 @@ test/mrWolf/bench_*.csv
 
 junit-reports
 
-doc/html/
-doc/latex/
+docs/html/
+docs/xml/
 
 *.S
+
+gmon.out

doc/doc_config → docs/Doxyfile

@@ -1,4 +1,4 @@
-# Doxyfile 1.8.5
+# Doxyfile 1.8.5 -- for doxybook2 use Doxygen 1.8.16 or newer.
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -1530,7 +1530,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1769,7 +1769,9 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+# Necessary for doxybook2
+
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

docs/doxybook2.json

@@ -0,0 +1,13 @@
+{
+  "baseUrl": "/pulp-dsp/docs/",
+  "indexInFolders": true,
+  "linkSuffix": "/",
+  "indexClassesName": "index",
+  "indexFilesName": "index",
+  "indexGroupsName": "index",
+  "indexNamespacesName": "index",
+  "indexRelatedPagesName": "index",
+  "indexExamplesName": "index",
+  "mainPageInRoot": true,
+  "mainPageName": "index"
+}

docs/requirements.txt

@@ -0,0 +1,3 @@
+# Keep sorted.
+mkdocs
+mkdocs-material

mkdocs.yml

@@ -8,3 +8,12 @@ theme:
 repo_url: https://github.com/pulp-platform/pulp-dsp
 repo_name: pulp-platform/pulp-dsp
 
+nav:
+- Home: index.md
+- Docs:
+  - Pages: docs/Pages/index.md
+  - Files: docs/Files/index.md
+  - Classes: docs/Classes/index.md
+  - Examples: docs/Examples/index.md
+  - Modules: docs/Modules/index.md
+  - Namespaces: docs/Namespaces/index.md