feat: mkdocs

Author: tolstenko

.github/workflows/documentation.yaml

@@ -29,19 +29,23 @@ jobs:
       - name: Install dependencies
         run: |
           apt install -y doxygen gource libgs-dev
-          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin
+          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude
+          npm install 
 
       - name: Configure
         run: emcmake cmake -S. -Bbuild -DENABLE_TEST_COVERAGE=OFF -DENABLE_STANDALONE=ON -DENABLE_DOCUMENTATION=ON
 
-      - name: Build Docs
-        run: cmake --build build --target GenerateDocs
+#      - name: Build Docs
+#        run: cmake --build build --target GenerateDocs
+#
+#      - name: Build Emscripten
+#        run: cmake --build build -j4 --config Release
 
-      - name: Build Emscripten
-        run: cmake --build build -j4 --config Release
+      - name: mkdocs
+        run: mkdocs build
 
       - name: COPY CNAME
-        run: cp CNAME ./build/documentation/doxygen/html/
+        run: cp CNAME ./site
 
 #      - name: Copy Emscripten build to docs
 #        run: cp -R build/out/* build/documentation/doxygen/html/
@@ -50,4 +54,4 @@ jobs:
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build/documentation/doxygen/html
+          publish_dir: ./site

.gitignore

@@ -38,3 +38,7 @@ cmake-*/
 out/
 build*/
 site/
+
+# caches
+node_modules/
+package-lock.json

documentation/CMakeLists.txt

@@ -9,6 +9,11 @@ include(../cmake/get_cpm.cmake)
 CPMAddPackage("gh:mosra/m.css#0da03060e30a23c0e9e54b0e25b71e9d2733d616")
 # CPMAddPackage(NAME Concurrency SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/..)
 
+find_package(Doxygen)
+if(NOT DOXYGEN_FOUND)
+  message(FATAL_ERROR "Doxygen need to be installed to generate the doxygen documentation")
+endif()
+
 # ---- Doxygen variables ----
 
 # set Doxyfile variables
@@ -19,12 +24,14 @@ set(DOXYGEN_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
 
 configure_file(${CMAKE_CURRENT_LIST_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
-configure_file(${CMAKE_CURRENT_LIST_DIR}/conf.py ${CMAKE_CURRENT_BINARY_DIR}/conf.py)
-
 add_custom_target(
   GenerateDocs
-  ${CMAKE_COMMAND} -E make_directory "${DOXYGEN_OUTPUT_DIRECTORY}"
-  COMMAND "${m.css_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/conf.py"
+#  ${CMAKE_COMMAND} -E make_directory "${DOXYGEN_OUTPUT_DIRECTORY}"
+#  COMMAND "${m.css_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/conf.py"
+#  COMMAND doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
+#  COMMAND moxygen --anchors --groups --output ${CMAKE_CURRENT_SOURCE_DIR}/api/api-%s.md ${DOXYGEN_OUTPUT_DIRECTORY}/xml
+  COMMAND mkdocs
   COMMAND echo "Docs written to: ${DOXYGEN_OUTPUT_DIRECTORY}"
-  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../"
+#  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
 )

documentation/header.html documentation/api/.gitkeepdocumentation/header.html renamed to documentation/api/.gitkeep

@@ -141,6 +141,11 @@ plugins:
   - search:
       separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
   - minify
+  - exclude:
+      glob:
+        - node_modules/*
+        - buildDocs/*
+        - cmake-build-debug/*
 
 extra:
   analytics:

mkdocs.yml

@@ -44,6 +44,7 @@
     "@semantic-release/github": "^8.0.7",
     "@semantic-release/npm": "^9.0.1",
     "@semantic-release/release-notes-generator": "^10.0.3",
+    "moxygen": "^0.8.0",
     "rimraf": "^3.0.2"
   },
   "release": {