setup docs

.github/workflows/documentation.yml

@@ -0,0 +1,27 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

README.md

@@ -2,6 +2,7 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaio.github.io/CodecLz4.jl/stable)
 [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaio.github.io/CodecLz4.jl/latest)
+[![Build Status](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml)
 [![CodeCov](https://codecov.io/gh/JuliaIO/CodecLz4.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaIO/CodecLz4.jl)
 
 Provides transcoding codecs for compression and decompression with LZ4. Source: [LZ4](https://github.com/lz4/lz4)

docs/Project.toml

@@ -3,4 +3,4 @@ CodecLz4 = "5ba52731-8f18-5e0d-9241-30f10d1ec561"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "~0.22.4"
+Documenter = "1"

docs/make.jl

@@ -2,18 +2,13 @@ using Documenter, CodecLz4
 
 makedocs(;
     modules=[CodecLz4],
-    format=Documenter.HTML(),
     pages=[
         "Home" => "index.md",
     ],
-    repo="https://github.com/JuliaIO/CodecLz4.jl/blob/{commit}{path}#L{line}",
     sitename="CodecLz4.jl",
     authors="Invenia Technical Computing Corporation",
 )
 
 deploydocs(;
     repo="github.com/JuliaIO/CodecLz4.jl",
-    target="build",
-    deps=nothing,
-    make=nothing,
 )

docs/src/index.md

@@ -2,7 +2,7 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaio.github.io/CodecLz4.jl/stable)
 [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaio.github.io/CodecLz4.jl/latest)
-[![Build Status](https://travis-ci.com/JuliaIO/CodecLz4.jl.svg?branch=master)](https://travis-ci.com/JuliaIO/CodecLz4.jl)
+[![Build Status](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml)
 [![CodeCov](https://codecov.io/gh/JuliaIO/CodecLz4.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaIO/CodecLz4.jl)
 
 ```@autodocs