Update Dockerfiles, workflows, and documentation

- Updated Dockerfiles for arm64 and armhf architectures
- Updated GitHub Actions workflows for CMake and Doxygen
- Updated documentation CMakeLists.txt
- Added new Doxyfile for documentation generation

Author: epsilonrt

.github/docker/Dockerfile.arm64

@@ -19,8 +19,8 @@ RUN apt-get update && \
       fakeroot \
       doxygen \
       doxygen-latex \
-      graphviz 
-
+      graphviz \
+      && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /workspace
 COPY . /workspace

.github/docker/Dockerfile.armhf

@@ -19,7 +19,8 @@ RUN apt-get update && \
       fakeroot \
       doxygen \
       doxygen-latex \
-      graphviz 
+      graphviz \
+      && rm -rf /var/lib/apt/lists/*
 
 
 WORKDIR /workspace

.github/workflows/build_cmake_arm64.yml

@@ -1,4 +1,4 @@
-name: Build CMake on arm64 (debian)
+name: Build arm64
 
 on:
   workflow_dispatch:

.github/workflows/build_cmake_armhf.yml

@@ -1,4 +1,4 @@
-name: Build CMake on armhf (debian)
+name: Build armhf
 
 on:
   workflow_dispatch:

.github/workflows/doxygen-gh-pages.yml

@@ -15,4 +15,4 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages
           folder: docs
-          config_file: Doxyfile
+          config_file: doc/Doxyfile

doc/CMakeLists.txt

@@ -29,46 +29,44 @@ if("${CMAKE_PROJECT_NAME}" STREQUAL "Project")
 endif()
 
 if (PIDUINO_WITH_DOXYGEN_DOC)
-
   find_package(Doxygen REQUIRED)
-  set(DOXYGEN_README ${PROJECT_SOURCE_DIR}/README.md)
-  set(DOXYGEN_FILE ${CMAKE_BINARY_DIR}/Doxyfile)
-  set(DOXYGEN_MAINPAGE ${CMAKE_BINARY_DIR}/main_page.dox)
-
-  set(DOXYGEN_INPUT_LIST 
-    ${PROJECT_SOURCE_DIR}/include/piduino/*.h
-    )
-
-  set(DOXYGEN_INPUT "${CMAKE_BINARY_DIR}/main_page.dox")
-  foreach(item ${DOXYGEN_INPUT_LIST})
-    get_filename_component(item_dir ${item} DIRECTORY)
-    string(APPEND DOXYGEN_INPUT " ${item_dir} ")
-  endforeach(item ${DOXYGEN_INPUT_LIST})
+  find_program(SED_EXECUTABLE sed)
 
-  #message("DOXYGEN_INPUT=${DOXYGEN_INPUT}")
+  if(NOT SED_EXECUTABLE)
+    message(FATAL_ERROR "sed is required but was not found. Please install sed.")
+  endif()
 
-  configure_file(Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile @ONLY)
-  configure_file(build_main_page.sh.in ${CMAKE_BINARY_DIR}/build_main_page.sh @ONLY)
+  set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+  set(DOXYFILE_BUILD ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+  # You must set the following variables to point to your project's files
+  set(DOXY_README "${PROJECT_SOURCE_DIR}/README.md")
+  set(DOXY_INPUT ${DOXY_README} ${PROJECT_SOURCE_DIR}/include/piduino)
+  set(DOXY_IMAGE_PATH "${PROJECT_SOURCE_DIR}/doc/images")
+  set(DOXY_PROJECT_LOGO "${PROJECT_SOURCE_DIR}/doc/images/PiduinoLogoSmall.png")
+  set(DOXY_EXAMPLE_PATH "${PROJECT_SOURCE_DIR}/examples")
 
-  add_custom_target(main_page.dox
-    COMMAND ${CMAKE_COMMAND} -E echo_append "Building API Documentation Main Page..."
-    COMMAND sh ${CMAKE_BINARY_DIR}/build_main_page.sh > /dev/null
-    COMMAND ${CMAKE_COMMAND} -E echo "Done."
-    DEPENDS main_page_header.dox main_page_footer.dox ${PROJECT_SOURCE_DIR}/README.md
-    )
+  # replace placeholders in the Doxyfile for local generation
+  add_custom_command(
+    OUTPUT ${DOXYFILE_BUILD}
+    COMMAND ${CMAKE_COMMAND} -E copy ${DOXYFILE_IN} ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^HTML_OUTPUT[[:space:]]*=.*|HTML_OUTPUT = ${CMAKE_CURRENT_BINARY_DIR}/html|' ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^INPUT[[:space:]]*=.*|INPUT = ${DOXY_INPUT}|' ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^IMAGE_PATH[[:space:]]*=.*|IMAGE_PATH = ${DOXY_IMAGE_PATH}|' ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^PROJECT_LOGO[[:space:]]*=.*|PROJECT_LOGO = ${DOXY_PROJECT_LOGO}|' ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^EXAMPLE_PATH[[:space:]]*=.*|EXAMPLE_PATH = ${DOXY_EXAMPLE_PATH}|' ${DOXYFILE_BUILD}
+    COMMAND ${SED_EXECUTABLE} -i 's|^USE_MDFILE_AS_MAINPAGE[[:space:]]*=.*|USE_MDFILE_AS_MAINPAGE = ${DOXY_README}|' ${DOXYFILE_BUILD}
+    DEPENDS ${DOXYFILE_IN}
+    COMMENT "Preparing Doxyfile for local documentation generation"
+  )
 
-  add_custom_target(html
-    COMMAND ${CMAKE_COMMAND} -E echo_append "Building API HTML Documentation..."
-    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_FILE} > /dev/null
-    COMMAND ${CMAKE_COMMAND} -E echo "Done."
-    DEPENDS main_page.dox DoxygenLayout.xml Doxyfile.in ${DOXYGEN_INPUT_LIST}
-    )
-  
-  add_custom_target(doc)
-  add_dependencies(doc main_page.dox html)
-  
-  #message("PIDUINO_INSTALL_DOC_DIR=${PIDUINO_INSTALL_DOC_DIR}")
+  add_custom_target(doc
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_BUILD}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    DEPENDS ${DOXYFILE_BUILD}
+    COMMENT "Generating API HTML documentation with Doxygen"
+    VERBATIM
+  )
 
-  install(DIRECTORY ${CMAKE_BINARY_DIR}/html/
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/
           DESTINATION ${PIDUINO_INSTALL_DOC_DIR}/api-manual COMPONENT doc)
 endif(PIDUINO_WITH_DOXYGEN_DOC)