Skip to content
Documentation

Release v0.4.2: warp-shuffle reductions, __nanosleep, libcu++ atomics #98

Sign in to view logs

Release v0.4.2: warp-shuffle reductions, __nanosleep, libcu++ atomics

Release v0.4.2: warp-shuffle reductions, __nanosleep, libcu++ atomics #98

Workflow file for this run

.github/workflows/docs.yml at cf0f7ad
name: Documentation
on:
push:
branches: [main, master]
workflow_dispatch:
# Note: CUDA features are opt-in (not default) so docs build succeeds without nvcc.
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
env:
CARGO_TERM_COLOR: always
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@nightly
- name: Cache Cargo dependencies
uses: Swatinem/rust-cache@v2
- name: Build API documentation
run: |
cargo doc --workspace --no-deps --document-private-items
env:
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
RUSTC_BOOTSTRAP: 1
- name: Setup Node.js for markdown processing
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install markdown-it
run: npm install markdown-it markdown-it-anchor
- name: Create documentation directory structure
run: |
mkdir -p ./docs-output/api
mkdir -p ./docs-output/guide
mkdir -p ./docs-output/guide/screenshots
# Copy API docs
cp -r ./target/doc/* ./docs-output/api/
# Copy screenshots for showcase documentation
if [ -d ./docs/screenshots ]; then
cp -r ./docs/screenshots/* ./docs-output/guide/screenshots/
fi
# Disable Jekyll processing
touch ./docs-output/.nojekyll
- name: Convert markdown guides to HTML
run: |
# Create a script to convert markdown to HTML with styling
cat > convert-md.js << 'SCRIPT'
const fs = require('fs');
const path = require('path');
const markdownIt = require('markdown-it');
const anchor = require('markdown-it-anchor');
const md = markdownIt({
html: true,
linkify: true,
typographer: true,
highlight: function (str, lang) {
return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
}
}).use(anchor, { permalink: anchor.permalink.headerLink() });
const template = (title, content, navLinks) => `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>${title} - RingKernel Documentation</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--primary: #f97316;
--primary-dark: #ea580c;
--bg-dark: #0f172a;
--bg-card: #1e293b;
--bg-code: #0d1117;
--text-primary: #f8fafc;
--text-secondary: #94a3b8;
--border: #334155;
--accent-green: #22c55e;
--accent-blue: #3b82f6;
--accent-purple: #a855f7;
}
* { margin: 0; padding: 0; box-sizing: border-box; }
body {
font-family: 'Inter', -apple-system, sans-serif;
background: var(--bg-dark);
color: var(--text-primary);
line-height: 1.7;
}
.container { max-width: 900px; margin: 0 auto; padding: 0 24px; }
header {
border-bottom: 1px solid var(--border);
padding: 16px 0;
position: sticky;
top: 0;
background: var(--bg-dark);
z-index: 100;
}
.header-content {
display: flex;
justify-content: space-between;
align-items: center;
max-width: 1200px;
margin: 0 auto;
padding: 0 24px;
}
.logo {
font-size: 1.5rem;
font-weight: 700;
color: var(--primary);
text-decoration: none;
}
nav a {
color: var(--text-secondary);
text-decoration: none;
margin-left: 24px;
font-size: 0.95rem;
transition: color 0.2s;
}
nav a:hover { color: var(--text-primary); }
main { padding: 48px 0 80px; }
article { max-width: 800px; margin: 0 auto; }
h1 { font-size: 2.5rem; margin-bottom: 24px; color: var(--text-primary); }
h2 { font-size: 1.75rem; margin: 48px 0 16px; padding-top: 24px; border-top: 1px solid var(--border); color: var(--text-primary); }
h3 { font-size: 1.35rem; margin: 32px 0 12px; color: var(--text-primary); }
h4 { font-size: 1.1rem; margin: 24px 0 8px; color: var(--text-primary); }
p { margin: 16px 0; color: var(--text-secondary); }
a { color: var(--primary); text-decoration: none; }
a:hover { text-decoration: underline; }
ul, ol { margin: 16px 0; padding-left: 24px; color: var(--text-secondary); }
li { margin: 8px 0; }
code {
font-family: 'JetBrains Mono', monospace;
background: var(--bg-code);
padding: 2px 6px;
border-radius: 4px;
font-size: 0.9em;
}
pre {
background: var(--bg-code);
border: 1px solid var(--border);
border-radius: 8px;
padding: 16px;
overflow-x: auto;
margin: 24px 0;
}
pre code {
background: none;
padding: 0;
font-size: 0.875rem;
line-height: 1.6;
}
table {
width: 100%;
border-collapse: collapse;
margin: 24px 0;
background: var(--bg-card);
border-radius: 8px;
overflow: hidden;
}
th, td {
padding: 12px 16px;
text-align: left;
border-bottom: 1px solid var(--border);
}
th { background: rgba(249, 115, 22, 0.1); font-weight: 600; }
blockquote {
border-left: 4px solid var(--primary);
padding-left: 16px;
margin: 24px 0;
color: var(--text-secondary);
font-style: italic;
}
hr { border: none; border-top: 1px solid var(--border); margin: 48px 0; }
.nav-links {
display: flex;
justify-content: space-between;
margin-top: 48px;
padding-top: 24px;
border-top: 1px solid var(--border);
}
.nav-link {
padding: 12px 20px;
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
text-decoration: none;
transition: all 0.2s;
}
.nav-link:hover {
border-color: var(--primary);
transform: translateY(-2px);
}
.nav-link span { display: block; font-size: 0.85rem; color: var(--text-secondary); }
.nav-link strong { color: var(--text-primary); }
footer {
border-top: 1px solid var(--border);
padding: 24px 0;
text-align: center;
color: var(--text-secondary);
font-size: 0.9rem;
}
.anchor { color: var(--text-secondary); margin-left: 8px; opacity: 0; transition: opacity 0.2s; }
h2:hover .anchor, h3:hover .anchor { opacity: 1; }
@media (max-width: 768px) {
h1 { font-size: 2rem; }
.header-content { flex-direction: column; gap: 12px; }
nav a { margin: 0 12px; }
}
</style>
</head>
<body>
<header>
<div class="header-content">
<a href="../index.html" class="logo">RingKernel</a>
<nav>
<a href="../index.html">Home</a>
<a href="../api/ringkernel/index.html">API Reference</a>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a>
</nav>
</div>
</header>
<main>
<div class="container">
<article>
${content}
${navLinks}
</article>
</div>
</main>
<footer>
<p>RingKernel Documentation &middot; <a href="https://github.com/mivertowski/RustCompute">GitHub</a></p>
</footer>
</body>
</html>`;
const guides = [
{ file: '01-architecture-overview.md', title: 'Architecture Overview' },
{ file: '02-crate-structure.md', title: 'Crate Structure' },
{ file: '03-core-abstractions.md', title: 'Core Abstractions' },
{ file: '04-memory-management.md', title: 'Memory Management' },
{ file: '05-gpu-backends.md', title: 'GPU Backends' },
{ file: '06-serialization.md', title: 'Serialization' },
{ file: '07-proc-macros.md', title: 'Proc Macros' },
{ file: '08-runtime.md', title: 'Runtime' },
{ file: '09-testing.md', title: 'Testing' },
{ file: '10-performance.md', title: 'Performance' },
{ file: '11-ecosystem.md', title: 'Ecosystem Integration' },
{ file: '12-migration.md', title: 'Migration Guide' },
{ file: '13-cuda-codegen.md', title: 'CUDA Codegen' },
{ file: '14-wgpu-codegen.md', title: 'WGSL Codegen' },
{ file: '15-showcase-applications.md', title: 'Showcase Applications' },
];
const docsDir = './docs';
const outDir = './docs-output/guide';
guides.forEach((guide, index) => {
const inputPath = path.join(docsDir, guide.file);
if (!fs.existsSync(inputPath)) {
console.log(`Skipping ${guide.file} (not found)`);
return;
}
let markdown = fs.readFileSync(inputPath, 'utf8');
// Remove Jekyll front matter if present
markdown = markdown.replace(/^---[\s\S]*?---\n/, '');
// Convert .md links to .html
markdown = markdown.replace(/\]\(\.\/(\d+-[^)]+)\.md\)/g, '](./$1.html)');
markdown = markdown.replace(/\]\((\d+-[^)]+)\.md\)/g, '](./$1.html)');
const content = md.render(markdown);
// Generate navigation links
let navLinks = '<div class="nav-links">';
if (index > 0) {
const prev = guides[index - 1];
const prevHref = './' + prev.file.replace('.md', '.html');
navLinks += '<a href="' + prevHref + '" class="nav-link"><span>Previous</span><strong>' + prev.title + '</strong></a>';
} else {
navLinks += '<div></div>';
}
if (index < guides.length - 1) {
const next = guides[index + 1];
const nextHref = './' + next.file.replace('.md', '.html');
navLinks += '<a href="' + nextHref + '" class="nav-link"><span>Next</span><strong>' + next.title + '</strong></a>';
}
navLinks += '</div>';
const outputPath = path.join(outDir, guide.file.replace('.md', '.html'));
fs.writeFileSync(outputPath, template(guide.title, content, navLinks));
console.log('Converted: ' + guide.file + ' -> ' + guide.file.replace('.md', '.html'));
});
SCRIPT
node convert-md.js
- name: Create landing page
run: |
cat > ./docs-output/index.html << 'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>RingKernel - GPU-native Persistent Actor Model for Rust</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--primary: #f97316;
--primary-dark: #ea580c;
--bg-dark: #0f172a;
--bg-card: #1e293b;
--text-primary: #f8fafc;
--text-secondary: #94a3b8;
--border: #334155;
--accent-green: #22c55e;
--accent-blue: #3b82f6;
--accent-purple: #a855f7;
}
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
background: var(--bg-dark);
color: var(--text-primary);
line-height: 1.6;
}
.container {
max-width: 1200px;
margin: 0 auto;
padding: 0 24px;
}
/* Header */
header {
border-bottom: 1px solid var(--border);
padding: 16px 0;
}
.header-content {
display: flex;
justify-content: space-between;
align-items: center;
}
.logo {
font-size: 1.5rem;
font-weight: 700;
color: var(--primary);
text-decoration: none;
}
nav a {
color: var(--text-secondary);
text-decoration: none;
margin-left: 24px;
font-size: 0.95rem;
transition: color 0.2s;
}
nav a:hover {
color: var(--text-primary);
}
/* Hero */
.hero {
padding: 80px 0;
text-align: center;
}
.hero h1 {
font-size: 3.5rem;
font-weight: 700;
margin-bottom: 16px;
background: linear-gradient(135deg, var(--text-primary) 0%, var(--primary) 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
.hero .subtitle {
font-size: 1.25rem;
color: var(--text-secondary);
max-width: 700px;
margin: 0 auto 32px;
}
.hero-buttons {
display: flex;
gap: 16px;
justify-content: center;
flex-wrap: wrap;
}
.btn {
display: inline-flex;
align-items: center;
padding: 12px 24px;
border-radius: 8px;
font-weight: 500;
text-decoration: none;
transition: all 0.2s;
}
.btn-primary {
background: var(--primary);
color: white;
}
.btn-primary:hover {
background: var(--primary-dark);
}
.btn-secondary {
background: var(--bg-card);
color: var(--text-primary);
border: 1px solid var(--border);
}
.btn-secondary:hover {
border-color: var(--text-secondary);
}
/* Features */
.features {
padding: 60px 0;
}
.features-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 24px;
}
.feature-card {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 12px;
padding: 24px;
}
.feature-card h3 {
font-size: 1.1rem;
margin-bottom: 8px;
display: flex;
align-items: center;
gap: 8px;
}
.feature-card p {
color: var(--text-secondary);
font-size: 0.95rem;
}
.icon {
width: 24px;
height: 24px;
display: inline-flex;
align-items: center;
justify-content: center;
}
/* Documentation Section */
.docs-section {
padding: 60px 0;
}
.docs-section h2 {
font-size: 2rem;
margin-bottom: 32px;
text-align: center;
}
.docs-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
gap: 20px;
}
.doc-link {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
padding: 20px;
text-decoration: none;
transition: all 0.2s;
display: block;
}
.doc-link:hover {
border-color: var(--primary);
transform: translateY(-2px);
}
.doc-link h4 {
color: var(--text-primary);
margin-bottom: 4px;
}
.doc-link p {
color: var(--text-secondary);
font-size: 0.9rem;
}
/* API Docs Banner */
.api-banner {
background: linear-gradient(135deg, var(--bg-card) 0%, #1a2744 100%);
border: 1px solid var(--border);
border-radius: 12px;
padding: 40px;
text-align: center;
margin: 40px 0;
}
.api-banner h3 {
font-size: 1.5rem;
margin-bottom: 12px;
}
.api-banner p {
color: var(--text-secondary);
margin-bottom: 20px;
}
/* Code Block */
.code-block {
background: var(--bg-card);
border: 1px solid var(--border);
border-radius: 8px;
padding: 20px;
font-family: 'JetBrains Mono', monospace;
font-size: 0.9rem;
overflow-x: auto;
margin: 32px 0;
}
.code-block code {
color: var(--text-secondary);
}
.code-block .keyword { color: var(--accent-purple); }
.code-block .string { color: var(--accent-green); }
.code-block .comment { color: #64748b; }
/* Backends Table */
.backends {
padding: 40px 0;
}
.backends h2 {
text-align: center;
margin-bottom: 24px;
}
table {
width: 100%;
border-collapse: collapse;
background: var(--bg-card);
border-radius: 8px;
overflow: hidden;
}
th, td {
padding: 12px 16px;
text-align: left;
border-bottom: 1px solid var(--border);
}
th {
background: rgba(249, 115, 22, 0.1);
font-weight: 600;
}
.status-stable {
color: var(--accent-green);
}
.status-planned {
color: var(--text-secondary);
}
/* Footer */
footer {
border-top: 1px solid var(--border);
padding: 40px 0;
text-align: center;
color: var(--text-secondary);
}
footer a {
color: var(--primary);
text-decoration: none;
}
@media (max-width: 768px) {
.hero h1 {
font-size: 2.5rem;
}
.header-content {
flex-direction: column;
gap: 16px;
}
nav a {
margin: 0 12px;
}
}
</style>
</head>
<body>
<header>
<div class="container header-content">
<a href="/" class="logo">RingKernel</a>
<nav>
<a href="#features">Features</a>
<a href="#docs">Documentation</a>
<a href="./api/ringkernel/index.html">API Reference</a>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a>
</nav>
</div>
</header>
<main>
<section class="hero">
<div class="container">
<h1>RingKernel</h1>
<p class="subtitle">
A GPU-native persistent actor model framework for Rust. Build high-performance
GPU-accelerated actor systems with persistent kernels, lock-free message passing,
and hybrid logical clocks.
</p>
<div class="hero-buttons">
<a href="./api/ringkernel/index.html" class="btn btn-primary">API Documentation</a>
<a href="./guide/01-architecture-overview.html" class="btn btn-secondary">Getting Started</a>
<a href="https://github.com/mivertowski/RustCompute" class="btn btn-secondary">View on GitHub</a>
</div>
</div>
</section>
<section class="features" id="features">
<div class="container">
<div class="features-grid">
<div class="feature-card">
<h3><span class="icon">&#x1F680;</span> Persistent GPU Kernels</h3>
<p>Long-running GPU kernels that maintain state across invocations, eliminating launch overhead.</p>
</div>
<div class="feature-card">
<h3><span class="icon">&#x1F517;</span> Lock-free Message Passing</h3>
<p>High-performance ring buffers for host-GPU and kernel-to-kernel communication.</p>
</div>
<div class="feature-card">
<h3><span class="icon">&#x23F1;</span> Hybrid Logical Clocks</h3>
<p>Causal ordering across distributed operations with HLC timestamps.</p>
</div>
<div class="feature-card">
<h3><span class="icon">&#x1F4E6;</span> Zero-Copy Serialization</h3>
<p>Efficient message passing with rkyv-based zero-copy serialization.</p>
</div>
<div class="feature-card">
<h3><span class="icon">&#x1F4BB;</span> Multi-Backend Support</h3>
<p>Target CPU, CUDA, WebGPU, or Metal with a unified API.</p>
</div>
<div class="feature-card">
<h3><span class="icon">&#x1F3AF;</span> Proc Macro DSL</h3>
<p>Declarative message and kernel definitions with derive macros.</p>
</div>
</div>
</div>
</section>
<section class="container">
<div class="code-block">
<code><span class="keyword">use</span> ringkernel::prelude::*;
<span class="keyword">async fn</span> main() -> std::result::Result&lt;(), Box&lt;<span class="keyword">dyn</span> std::error::Error&gt;&gt; {
<span class="comment">// Create runtime with auto-detected backend</span>
<span class="keyword">let</span> runtime = RingKernel::builder()
.backend(Backend::Auto)
.build()
.<span class="keyword">await</span>?;
<span class="comment">// Launch a persistent kernel</span>
<span class="keyword">let</span> kernel = runtime.launch(<span class="string">"processor"</span>, LaunchOptions::default()).<span class="keyword">await</span>?;
<span class="comment">// Kernel is active and ready</span>
println!(<span class="string">"State: {:?}"</span>, kernel.state());
runtime.shutdown().<span class="keyword">await</span>?;
Ok(())
}</code>
</div>
</section>
<section class="backends">
<div class="container">
<h2>Supported Backends</h2>
<table>
<thead>
<tr>
<th>Backend</th>
<th>Status</th>
<th>Platforms</th>
<th>Requirements</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>CPU</strong></td>
<td class="status-stable">Stable</td>
<td>All</td>
<td>None</td>
</tr>
<tr>
<td><strong>CUDA</strong></td>
<td class="status-stable">Stable</td>
<td>Linux, Windows</td>
<td>NVIDIA GPU, CUDA 12.x</td>
</tr>
<tr>
<td><strong>WebGPU</strong></td>
<td class="status-stable">Stable</td>
<td>All</td>
<td>Vulkan/Metal/DX12 capable GPU</td>
</tr>
<tr>
<td><strong>Metal</strong></td>
<td class="status-planned">Planned</td>
<td>macOS, iOS</td>
<td>-</td>
</tr>
</tbody>
</table>
</div>
</section>
<section class="docs-section" id="docs">
<div class="container">
<h2>Documentation</h2>
<div class="api-banner">
<h3>API Reference</h3>
<p>Complete API documentation generated from source code with rustdoc.</p>
<a href="./api/ringkernel/index.html" class="btn btn-primary">Browse API Docs</a>
</div>
<h3 style="margin-bottom: 16px;">Guide</h3>
<div class="docs-grid">
<a href="./guide/01-architecture-overview.html" class="doc-link">
<h4>Architecture Overview</h4>
<p>System design, component mapping, and kernel lifecycle.</p>
</a>
<a href="./guide/02-crate-structure.html" class="doc-link">
<h4>Crate Structure</h4>
<p>Workspace organization and crate responsibilities.</p>
</a>
<a href="./guide/03-core-abstractions.html" class="doc-link">
<h4>Core Abstractions</h4>
<p>Key traits, types, and the message queue system.</p>
</a>
<a href="./guide/04-memory-management.html" class="doc-link">
<h4>Memory Management</h4>
<p>GPU memory allocation and buffer handling.</p>
</a>
<a href="./guide/05-gpu-backends.html" class="doc-link">
<h4>GPU Backends</h4>
<p>Backend implementations: CPU, CUDA, WebGPU, Metal.</p>
</a>
<a href="./guide/06-serialization.html" class="doc-link">
<h4>Serialization</h4>
<p>Zero-copy serialization with rkyv and zerocopy.</p>
</a>
<a href="./guide/07-proc-macros.html" class="doc-link">
<h4>Proc Macros</h4>
<p>RingMessage, ring_kernel, and GpuType derive macros.</p>
</a>
<a href="./guide/08-runtime.html" class="doc-link">
<h4>Runtime</h4>
<p>Runtime configuration and kernel management.</p>
</a>
<a href="./guide/09-testing.html" class="doc-link">
<h4>Testing</h4>
<p>Testing strategies and GPU test patterns.</p>
</a>
<a href="./guide/10-performance.html" class="doc-link">
<h4>Performance</h4>
<p>Benchmarks, optimization, and profiling.</p>
</a>
<a href="./guide/11-ecosystem.html" class="doc-link">
<h4>Ecosystem</h4>
<p>Integration with other Rust libraries.</p>
</a>
<a href="./guide/12-migration.html" class="doc-link">
<h4>Migration Guide</h4>
<p>Upgrading between versions.</p>
</a>
<a href="./guide/13-cuda-codegen.html" class="doc-link">
<h4>CUDA Codegen</h4>
<p>Rust to CUDA transpiler documentation.</p>
</a>
<a href="./guide/14-wgpu-codegen.html" class="doc-link">
<h4>WGSL Codegen</h4>
<p>Rust to WGSL transpiler documentation.</p>
</a>
<a href="./guide/15-showcase-applications.html" class="doc-link">
<h4>Showcase Applications</h4>
<p>WaveSim, TxMon, and AccNet demos with screenshots.</p>
</a>
</div>
<h3 style="margin: 32px 0 16px;">Crate Documentation</h3>
<div class="docs-grid">
<a href="./api/ringkernel/index.html" class="doc-link">
<h4>ringkernel</h4>
<p>Main facade crate - start here</p>
</a>
<a href="./api/ringkernel_core/index.html" class="doc-link">
<h4>ringkernel-core</h4>
<p>Core traits, types, HLC, K2K, PubSub</p>
</a>
<a href="./api/ringkernel_derive/index.html" class="doc-link">
<h4>ringkernel-derive</h4>
<p>Proc macros for messages and kernels</p>
</a>
<a href="./api/ringkernel_cpu/index.html" class="doc-link">
<h4>ringkernel-cpu</h4>
<p>CPU backend implementation</p>
</a>
<a href="./api/ringkernel_cuda/index.html" class="doc-link">
<h4>ringkernel-cuda</h4>
<p>NVIDIA CUDA backend</p>
</a>
<a href="./api/ringkernel_wgpu/index.html" class="doc-link">
<h4>ringkernel-wgpu</h4>
<p>WebGPU cross-platform backend</p>
</a>
</div>
</div>
</section>
</main>
<footer>
<div class="container">
<p>
RingKernel is licensed under <a href="https://github.com/mivertowski/RustCompute/blob/main/LICENSE">Apache-2.0</a>.
<br>
<a href="https://github.com/mivertowski/RustCompute">GitHub</a> &middot;
<a href="./api/ringkernel/index.html">API Docs</a> &middot;
<a href="https://crates.io/crates/ringkernel">crates.io</a>
</p>
</div>
</footer>
</body>
</html>
EOF
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs-output'
deploy:
name: Deploy to GitHub Pages
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4