Documentation

.github/workflows/document.yaml

@@ -0,0 +1,26 @@
+name: document
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          submodules: true
+      - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
+      - uses: swatinem/rust-cache@6323deb102c322ba6fcbdcafc7e3dddab59af2b6 # v2.9.2
+      - run: cargo doc --no-deps
+      - run: rm target/doc/.lock
+      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: target/doc
+      - uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
+        if: github.ref == 'refs/heads/main'

Cargo.toml

@@ -3,6 +3,7 @@ name = "bdwgc-alloc"
 version = "0.6.13"
 edition = "2024"
 description = "impl GlobalAlloc for bdwgc"
+documentation = "https://bdwgc.github.io/bdwgc-rust/bdwgc_alloc/"
 repository = "https://github.com/raviqqe/bdwgc-alloc"
 license = "MIT"
 categories = ["api-bindings", "memory-management", "no-std", "no-std::no-alloc"]

README.md

@@ -2,7 +2,7 @@
 
 [![GitHub Action](https://img.shields.io/github/actions/workflow/status/bdwgc/bdwgc-rust/test.yaml?branch=main&style=flat-square)](https://github.com/bdwgc/bdwgc-rust/actions)
 [![Crate](https://img.shields.io/crates/v/bdwgc-alloc.svg?style=flat-square)](https://crates.io/crates/bdwgc-alloc)
-[![License](https://img.shields.io/github/license/bdwgc/bdwgc-rust.svg?style=flat-square)](LICENSE)
+[![License](https://img.shields.io/github/license/bdwgc/bdwgc-rust.svg?style=flat-square)](https://github.com/bdwgc/bdwgc-rust/blob/main/LICENSE)
 
 [`GlobalAlloc`](https://doc.rust-lang.org/std/alloc/trait.GlobalAlloc.html) implementation for [`bdwgc`][bdwgc], the conservative garbage collector.
 
@@ -10,7 +10,7 @@ This crate is for use cases in which developers need to integrate [`bdwgc`][bdwg
 
 ## Usage
 
-See [`examples`](examples) directory.
+See [`examples`](https://github.com/bdwgc/bdwgc-rust/tree/main/examples) directory.
 
 By default [`bdwgc`][bdwgc] is built with autotools. To build with cmake, enable the `cmake` feature:
 
@@ -20,6 +20,6 @@ cargo build --no-default-features --features cmake
 
 ## License
 
-[MIT](LICENSE)
+[MIT](https://github.com/bdwgc/bdwgc-rust/blob/main/LICENSE)
 
 [bdwgc]: https://github.com/bdwgc/bdwgc