Merge pull request #32 from prince-chrismc/update-doxygen

Update doxygen

.github/workflows/documentation.yml

@@ -3,17 +3,22 @@ name: Documentation CI
 on:
   push:
     branches: [master]
+  workflow_dispatch: {}
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: ssciwr/doxygen-install@v1
+        with:
+          version: "1.9.8"
       - run: sudo apt install graphviz
-      - run: wget https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v1.6.1/doxygen-awesome.css
-      - run: wget https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v1.6.1/doxygen-awesome-sidebar-only.css
-      - uses: mattnotmitt/doxygen-action@v1
-      - name: deploy
+      - run: | 
+          cmake .
+          cmake --build . --target
+      - if: github.event_name == 'push'
+        name: deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -306,12 +306,15 @@ $RECYCLE.BIN/
 test
 *.o
 *.o.d
-.vscode
+
+# IDE-specific files
+.vscode/
+.vscode/!extensions.json # Allow to provide recommended extensions
+
 # ClangD cache files
 .cache
 
 doxy/
-doxygen-awesome*.css
 
 build/*
 package-lock.json

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "ms-vscode.cpptools",
+        "ms-vscode.cpptools-extension-pack",
+        "ms-vscode.cmake-tools",
+        "twxs.cmake",
+        "GitHub.vscode-github-actions"
+    ]
+}

CMakeLists.txt

@@ -17,6 +17,7 @@ project(jwt-cpp)
 
 option(JWT_BUILD_EXAMPLES "Configure CMake to build examples (or not)" ON)
 option(JWT_BUILD_TESTS "Configure CMake to build tests (or not)" OFF)
+option(JWT_BUILD_DOC "Configure CMake to build documentation (or not)" OFF)
 option(JWT_ENABLE_COVERAGE "Enable code coverage testing" OFF)
 option(JWT_ENABLE_FUZZING "Enable fuzz testing" OFF)
 
@@ -155,3 +156,7 @@ endif()
 if(JWT_ENABLE_FUZZING)
   add_subdirectory(tests/fuzz)
 endif()
+
+if(JWT_BUILD_DOC)
+  add_subdirectory(docs)
+endif()

docs/.gitignore

@@ -0,0 +1 @@
+doxygen-awesome*.css

docs/CMakeLists.txt

@@ -0,0 +1,9 @@
+file(DOWNLOAD https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v1.6.1/doxygen-awesome.css
+     ${CMAKE_CURRENT_LIST_DIR}/doxygen-awesome.css
+     EXPECTED_HASH SHA256=15e861215d73d8dd6c39e585b5ed647e515dd9a782215b8e5dc6724cd51f31b6)
+file(DOWNLOAD https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v1.6.1/doxygen-awesome-sidebar-only.css
+     ${CMAKE_CURRENT_LIST_DIR}/doxygen-awesome-sidebar-only.css
+     EXPECTED_HASH SHA256=aa8a9cc16730a22b1c901504835914144b96821e74d858605d80bc11907c4e3a)
+
+add_custom_target(build_doxy COMMAND doxygen ${CMAKE_CURRENT_LIST_DIR}/Doxyfile WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+                  BYPRODUCTS ${PROJECT_SOURCE_DIR}/doxy/index.html)