Add docs

.github/workflows/CI.yml

@@ -18,7 +18,8 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.9'
+          - '1.8' # earliest supported version
+          - '1' # stable
           - 'nightly'
         os:
           - ubuntu-latest

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Documentation
+on:
+  push:
+    branches: [main]
+    tags: '*'
+    paths:
+      - '.github/workflows/docs.yml'
+      - 'src/**'
+      - 'docs/**'
+      - 'Project.toml'
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - '.github/workflows/docs.yml'
+      - 'src/**'
+      - 'docs/**'
+      - 'Project.toml'
+
+jobs:
+  Documentation:
+    # Run on push's or non-draft PRs
+    if: (github.event_name == 'push') || (github.event.pull_request.draft == false) || (github.event_name == 'workflow_dispatch')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: "1.8"
+      - name: Cache artifacts
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: |
+            ~/.julia/artifacts
+          key: ${{ runner.os }}-docs-${{ env.cache-name }}-${{ hashFiles('**/docs/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-docs-${{ env.cache-name }}-
+            ${{ runner.os }}-docs-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        shell: julia --color=yes --project=docs/ {0}
+        run: |
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
+      - uses: julia-actions/julia-docdeploy@releases/v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key

.gitignore

@@ -2,3 +2,4 @@
 *.jl.cov
 *.jl.mem
 /Manifest.toml
+docs/build

Project.toml

@@ -15,7 +15,7 @@ Aqua = "0.7"
 Bumper = "0.3"
 ScopedValues = "1"
 StrideArraysCore = "0.5"
-julia = "1.9"
+julia = "1.8"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"

README.md

@@ -71,7 +71,7 @@ Before using a bump allocator (`with_bumper` or `with_locked_bumper`) it is reco
 Note also:
 
 - Just as with all usage of Bumper.jl, the user is responsible for only using Bumper's `@no_escape` when newly allocated arrays truly will not escape
-  - with AllocArrays this can be slightly more subtle, because within `with_bumper` or `with_locked_bumper` block, `similar` calls on `AllocArrays` will allocate using the bump allocator. Thus, one must be sure that none of those allocations leak past a `@no_escape` block. The simplest way to do so is to be sure no allocations of any kind leak past a `@no_escape` block.
+  - with AllocArrays this can be slightly more subtle, because within `with_bumper` or `with_locked_bumper` block, `similar` calls on `AllocArray`s will allocate using the bump allocator. Thus, one must be sure that none of those allocations leak past a `@no_escape` block. The simplest way to do so is to be sure no allocations of any kind leak past a `@no_escape` block.
 - Calling `with_bumper(f)` (without a buffer argument) is concurrency-safe by virtue of using Bumper.jl's dynamic task-local buffers.
   - This can be slow and allocation heavy, however, if there are many short-lived tasks that each allocate, since they will each need to be provisioned their own buffer.
 - Calling `with_bumper(f, buf)` (with a buffer argument) is not safe if allocations may occur across threads. Since you may not know all the `similar` calls present in the code, this is a-priori dangerous to use.