TBD

Colin Davidson · Colin Davidson · commit 8b5b9f1bd9b5 · 2025-08-01T16:42:51.000+01:00
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -2,6 +2,7 @@
 name: Deploy Jekyll with GitHub Pages dependencies preinstalled
 
 on:
+  # branch_protection_rule:
   # Runs on pushes targeting the default branch
   push:
     branches: ["colin/publish_docs"]
@@ -23,19 +24,68 @@ concurrency:
 
 jobs:
   # Build job
-  build:
-    if: github.repository == 'uxlfoundation/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'  
+  # build_rfc:
+  #   # if: github.repository == 'uxlfoundation/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'  
+  #   if: github.repository == 'coldav/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'  
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v4
+  #       with:
+  #         ref: rfcs
+  #     - name: Setup Pages
+  #       uses: actions/configure-pages@v5
+  #     - name: Build with Jekyll
+  #       uses: actions/jekyll-build-pages@v1
+  #       with:
+  #         source: ./
+  #         destination: ./_site/rfcs
+  #     - name: Upload artifact
+  #       uses: actions/upload-pages-artifact@v3
+
+  build_ock_docs:
+    # if: github.repository == 'uxlfoundation/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'  
+    if: github.repository == 'coldav/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'  
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        ref: rfcs
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Install apt package
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen virtualenv
+
+      - name: Install prerequisites
+        run: python -m pip install -r doc/requirements.txt
+
+      - name: Build Documentation
+        working-directory: ${{github.workspace}}
+        run: |
+          cmake -DCMAKE_BUILD_TYPE=Debug -DCA_RUNTIME_COMPILER_ENABLED=OFF -DCA_CL_ENABLE_OFFLINE_KERNEL_TESTS=OFF -DOCL_EXTENSION_cl_khr_il_program=OFF -Bbuild_doc
+          cmake --build build_doc --target doc_html
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: rfcs
+          path: rfcs
+
+      - name: Move rfcs to build_doc
+        shell: bash
+        run:
+          mv rfcs build_doc/doc
+         
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
-          source: ./
+          source: ./build_doc/doc
           destination: ./_site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
@@ -46,7 +96,7 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
-    needs: build
+    needs: [ build_ock_docs ]
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -118,7 +118,8 @@ endif()
 add_custom_target(doc_html
   COMMAND ${SPHINX_BUILD} --color -b html
     ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/html
-  DEPENDS doc-copy doxygen
+  DEPENDS doc-copy
+  # doxygen
   USES_TERMINAL COMMENT "Generate Documentation HTML")
 
 # PDF documentation generatation is not currently supported on Windows since
diff --git a/doc/cmake/FindModules.rst b/doc/cmake/FindModules.rst
@@ -39,10 +39,10 @@ FindGitClangFormat Module
 .. seealso::
   Used to implement the :doc:`/cmake/Format`.
 
-FindLLVMTool Module
+ImportLLVM Module
 ###################
 
-.. cmake-module:: ../../cmake/FindLLVMTool.cmake
+.. cmake-module:: ../../cmake/ImportLLVM.cmake
 
 FindLit Module
 ##############
diff --git a/doc/developer-guide.md b/doc/developer-guide.md
@@ -745,7 +745,7 @@ To cross-compile LLVM the appropriate CMake toolchain file from the oneAPI
 Construction Kit repository may be used; the path to this repository will be
 specified by the `$ONEAPI_CON_KIT` variable in the following examples.
 
-##### Cross-compiling LLVM for ARM
+#### Cross-compiling LLVM for ARM
 
 For cross-compilation targeting ARM, only the `ARM` target back end needs to be
 enabled. Run the following command to configure an LLVM build targeting ARM from
@@ -770,7 +770,7 @@ Now the build directory is configured, build the `install` target.
 ninja -C build-arm install
 ```
 
-##### Cross-compiling LLVM for AArch64
+#### Cross-compiling LLVM for AArch64
 
 For cross-compilation targeting AArch64 only the `AArch64` target back end needs
 to be enabled. Run the following command to configure an LLVM build targeting
@@ -795,7 +795,7 @@ Now the build directory is configured, build the `install` target.
 ninja -C build-aarch64 install
 ```
 
-##### Cross-compiling LLVM for RISC-V
+#### Cross-compiling LLVM for RISC-V
 
 For cross-compilation targeting RISC-V only the `RISCV` target back end needs
 to be enabled. Run the following command to configure an LLVM build targeting
diff --git a/doc/getting-started.rst b/doc/getting-started.rst
@@ -113,7 +113,7 @@ configuration.
 * `Git`_
 * `CMake`_ 3.4.3+
 * `Python`_ 3.6.9+
-* `Vulkan SDK`_ 1.1.97+
+* `LunarG Vulkan SDK packages`_ 1.1.97+
 
 Windows 10 does not provide an adequate package manager. However, the
 third-party `Chocolatey <https://chocolatey.org/install#install-with-cmdexe>`_
diff --git a/doc/modules/mux.rst b/doc/modules/mux.rst
@@ -9,11 +9,6 @@ ComputeMux
    CMake <mux/cmake>
    Bumping the Specification Version <mux/bumping-the-spec>
 
-.. toctree::
-   :hidden:
-
-   mux/hal/dynamic_loading
-
 .. seealso::
    The :doc:`/specifications/mux-runtime-spec` and the
    :doc:`/specifications/mux-compiler-spec`.
diff --git a/doc/modules/mux/changes.rst b/doc/modules/mux/changes.rst
@@ -53,11 +53,11 @@ version increases mean backward compatible bug fixes have been applied.
 
 * Several ``compiler::BaseModule`` methods and fields have been reworked to
   make compilation of OpenCL less stateful.
-  * The class-member lists of macro defs and OpenCL options have been removed,
+  - The class-member lists of macro defs and OpenCL options have been removed,
     and are set up and torn down on the fly when compiling OpenCL C.
-  * Several methods such as ``compiler::BaseModule::populatePPOpts`` are now
+  - Several methods such as ``compiler::BaseModule::populatePPOpts`` are now
     ``const``.
-  * ``compiler::BaseModule::executeOpenCLAction`` has been removed.
+  - ``compiler::BaseModule::executeOpenCLAction`` has been removed.
 
 0.73.0
 ------
diff --git a/doc/overview/compiler/ir.rst b/doc/overview/compiler/ir.rst
@@ -624,8 +624,7 @@ the `OpenCL C atomic`_ and `OpenCL C fence`_ operations and the `SPIR-V atomic`_
 and `SPIR-V barrier`_ operations. Synchronization on non-atomic memory access
 is defined by a *memory consistency model*. The memory consistency requirements
 made on the instruction listed in the Mux compiler spec enables the oneAPI
-Construction Kit to support the higher level `OpenCL memory consistency model`_
-and the `Vulkan memory model`_.
+Construction Kit to support the higher level `OpenCL memory consistency model`_.
 
 .. _OpenCL C atomic:
    https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_C.html#atomic-functions
diff --git a/doc/specifications.rst b/doc/specifications.rst
@@ -7,4 +7,3 @@ Specifications
    specifications/versioning
    specifications/mux-runtime-spec
    specifications/mux-compiler-spec
-   specifications/hal
