Starting with docs

Author: michel2323

.github/workflows/DocsCleanup.yml

@@ -0,0 +1,28 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+
+      - name: Delete preview and history
+        run: |
+            git config user.name "oneAPI.jl"
+            git config user.email "oneapi@juliagpu.github.io"
+            git rm -rf "previews/PR$PRNUM"
+            git commit -m "delete preview"
+            git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+        env:
+            PRNUM: ${{ github.event.number }}
+
+      - name: Push changes
+        run: |
+            git push --force origin gh-pages-new:gh-pages

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+    types: [opened, synchronize, reopened]
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  docs:
+    name: Build documentation
+    env:
+      DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      JULIA_DEBUG: Documenter
+    runs-on: [self-hosted, linux, X64]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 'lts'
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@latest
+      - run: julia --project=docs/ docs/make.jl

.gitignore

@@ -6,3 +6,4 @@ deps/onemkl_lapack.cpp
 deps/onemkl_lapack.h
 deps/onemkl_sparse.cpp
 deps/onemkl_sparse.h
+docs/build

README.md

@@ -2,7 +2,7 @@
 
 *Julia support for the oneAPI programming toolkit.*
 
-[![][doi-img]][doi-url] [![][buildkite-img]][buildkite-url] [![][codecov-img]][codecov-url]
+[![][doi-img]][doi-url] [![][buildkite-img]][buildkite-url] [![][codecov-img]][codecov-url] [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url]
 
 [doi-img]: https://zenodo.org/badge/252466420.svg
 [doi-url]: https://zenodo.org/badge/latestdoi/252466420
@@ -13,6 +13,12 @@
 [codecov-img]: https://codecov.io/gh/JuliaGPU/oneAPI.jl/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/JuliaGPU/oneAPI.jl
 
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://juliagpu.github.io/oneAPI.jl/stable
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://juliagpu.github.io/oneAPI.jl/dev
+
 oneAPI.jl provides support for working with the [oneAPI unified programming
 model](https://software.intel.com/en-us/oneapi). The package is verified to work with the
 (currently) only implementation of this interface [that is part of the Intel Compute

docs/Project.toml

@@ -0,0 +1,9 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+oneAPI = "8f75cd03-7ff8-4ecb-9b8f-daf728133b1b"
+
+[sources]
+oneAPI = {path = "/home/michel/git/oneAPI.jl"}
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -0,0 +1,54 @@
+using Pkg
+
+Pkg.develop(PackageSpec(path=joinpath(dirname(@__FILE__), "..")))
+# # when first running instantiate
+Pkg.instantiate()
+using Documenter
+using Documenter.Remotes
+using oneAPI
+
+oneAPI.versioninfo()
+
+makedocs(
+    sitename = "oneAPI.jl",
+    format = Documenter.HTML(
+        prettyurls = Base.get(ENV, "CI", nothing) == "true",
+        canonical = "https://exanauts.github.io/ExaPF.jl/stable/",
+        mathengine = Documenter.KaTeX(),
+    ),
+    modules = [oneAPI],
+    pages = [
+        "Home" => "index.md",
+        "Installation" => "installation.md",
+        "Getting Started" => "getting_started.md",
+        "Usage" => [
+            "Array Programming" => "arrays.md",
+            "Kernel Programming" => "kernels.md",
+            "Memory Management" => "memory.md",
+            "Device Intrinsics" => "device.md",
+            "Performance Guide" => "usage/performance.md",
+        ],
+        "API Reference" => [
+            "Overview" => "api.md",
+            "Context & Device Management" => "api/context.md",
+            "Array Operations" => "api/arrays.md",
+            "Kernel Programming" => "api/kernels.md",
+            "Memory Management" => "api/memory.md",
+            "Compiler & Reflection" => "api/compiler.md",
+            "Level Zero (oneL0)" => "level_zero.md",
+            "oneMKL" => "onemkl.md",
+        ],
+        "Troubleshooting" => "troubleshooting.md",
+    ],
+    checkdocs = :none,  # Don't error on missing docstrings
+    warnonly = [:cross_references, :missing_docs],  # Only warn, don't error
+)
+
+deploydocs(
+    repo = "github.com/JuliaGPU/oneAPI.jl.git",
+    target = "build",
+    devbranch = "main",
+    devurl = "dev",
+    push_preview = true,
+)
+

docs/src/api.md

@@ -0,0 +1,42 @@
+# API Reference
+
+This page provides an overview of the oneAPI.jl API. For detailed documentation, see the specific API reference pages:
+
+- [Context & Device Management](api/context.md) - Managing drivers, devices, and contexts
+- [Array Operations](api/arrays.md) - Working with GPU arrays
+- [Kernel Programming](api/kernels.md) - Writing and launching custom kernels
+- [Memory Management](api/memory.md) - Memory allocation and transfer
+- [Compiler & Reflection](api/compiler.md) - Code generation and introspection
+
+## Core Functions
+
+```@autodocs
+Modules = [oneAPI]
+Pages   = ["src/context.jl", "src/utils.jl"]
+Filter = t -> t !== oneAPI.synchronize
+```
+
+## Compiler Functions
+
+```@autodocs
+Modules = [oneAPI]
+Pages = ["src/compiler/execution.jl", "src/compiler/reflection.jl"]
+```
+
+## oneL0 (Level Zero)
+
+Low-level bindings to the Level Zero API. See the [Level Zero page](level_zero.md) for details.
+
+```@autodocs
+Modules = [oneAPI.oneL0]
+Filter = t -> t !== oneAPI.oneL0.synchronize
+```
+
+## oneMKL
+
+Intel oneAPI Math Kernel Library bindings. See the [oneMKL page](onemkl.md) for details.
+
+```@autodocs
+Modules = [oneAPI.oneMKL]
+```
+