Merge branch 'staging' into release

Author: steven-varga

.github/workflows/docs.yml

@@ -5,12 +5,12 @@ on:
     branches: [release, staging]
 
 permissions:
-  contents: write 
+  contents: write
 
 jobs:
-  deploy:
+  # MkDocs — conceptual docs, architecture pages, guides
+  deploy-mkdocs:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repo
         uses: actions/checkout@v6
@@ -21,14 +21,37 @@ jobs:
           python-version: '3.x'
 
       - name: Install MkDocs + Material theme
-        run: |
-          pip install mkdocs mkdocs-material
+        run: pip install mkdocs mkdocs-material
 
-      - name: Build documentation
+      - name: Build MkDocs site
         run: mkdocs build
 
-      - name: Deploy to GitHub Pages
+      - name: Deploy MkDocs to gh-pages root
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./site
+          keep_files: true
+
+  # Doxygen — API reference generated from C++ headers
+  deploy-doxygen:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y doxygen
+
+      - name: Build Doxygen API reference
+        run: cd doxy && doxygen Doxyfile
+
+      - name: Deploy Doxygen to gh-pages/api
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/doxygen/html
+          destination_dir: api
+          keep_files: true

.gitignore

@@ -54,3 +54,4 @@ compile_commands.json
 h5cpp.hpp
 
 .cache/
+docs/doxygen/

CMakeLists.txt

@@ -97,6 +97,29 @@ if(HDF5_VERSION VERSION_GREATER 1.12.0)
     message(STATUS "H5CPP KITA support is available, see webpage for details...")
 endif()
 
+# ─── ROS3 VFD detection ───────────────────────────────────────────────────────────
+foreach(_hdf5_inc IN LISTS HDF5_INCLUDE_DIRS)
+    foreach(_pubconf IN ITEMS "H5pubconf.h" "H5pubconf-64.h")
+        if(EXISTS "${_hdf5_inc}/${_pubconf}")
+            file(STRINGS "${_hdf5_inc}/${_pubconf}" _ros3_line REGEX "H5_HAVE_ROS3_VFD")
+            if(_ros3_line MATCHES "#define H5_HAVE_ROS3_VFD")
+                set(H5CPP_HAVE_ROS3_VFD TRUE)
+                break()
+            endif()
+        endif()
+    endforeach()
+    if(H5CPP_HAVE_ROS3_VFD)
+        break()
+    endif()
+endforeach()
+if(H5CPP_HAVE_ROS3_VFD)
+    message(STATUS "H5CPP: ROS3 VFD detected — S3 read-only support enabled")
+else()
+    message(STATUS "H5CPP: ROS3 VFD not found — S3 support disabled")
+endif()
+
+option(H5CPP_NETWORK_TESTS "Enable network-dependent tests (requires outbound S3 access)" OFF)
+
 # ─── MPI (optional) ───────────────────────────────────────────────────────────────
 find_package(MPI QUIET COMPONENTS C CXX)
 if(MPI_FOUND AND HDF5_IS_PARALLEL)
@@ -171,6 +194,10 @@ target_include_directories(h5cpp INTERFACE
 target_link_libraries(h5cpp INTERFACE ${H5CPP_LIBS})
 target_compile_features(h5cpp INTERFACE cxx_std_17)
 
+if(H5CPP_HAVE_ROS3_VFD)
+    target_compile_definitions(h5cpp INTERFACE H5CPP_HAVE_ROS3_VFD=1)
+endif()
+
 if(H5CPP_LIBDEFLATE_FOUND)
     target_link_libraries(h5cpp INTERFACE ${H5CPP_LIBDEFLATE_TARGET})
 else()

Makefile

@@ -54,8 +54,13 @@ DOCS_DIR ?= docs
 SITE_DIR ?= site
 DOCS_REQUIREMENTS ?= requirements-docs.txt
 
+DOXY          ?= doxygen
+DOXY_DIR       = doxy
+DOXY_OUT       = docs/doxygen/html
+
 .PHONY: docs docs-build docs-serve docs-strict docs-deploy \
-        docs-clean docs-install docs-venv docs-bootstrap venv-clean
+        docs-clean docs-install docs-venv docs-bootstrap venv-clean \
+        docs-doxygen docs-doxygen-view docs-doxygen-clean
 
 $(VENV_PYTHON):
 	$(PYTHON) -m venv $(VENV_DIR)
@@ -89,6 +94,15 @@ docs-deploy: $(VENV_PYTHON)
 docs-clean:
 	rm -rf $(SITE_DIR)
 
+docs-doxygen:
+	cd $(DOXY_DIR) && $(DOXY) Doxyfile 2>&1 | tee doxygen.log
+
+docs-doxygen-view: docs-doxygen
+	xdg-open $(DOXY_OUT)/index.html
+
+docs-doxygen-clean:
+	$(RM) -rf docs/doxygen $(DOXY_DIR)/doxygen.log
+
 venv-clean:
 	rm -rf $(VENV_DIR)