feat: add docs

.github/workflows/build.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# generate coverage report
+cargo +stable install cargo-llvm-cov --locked
+cargo llvm-cov --html
+
+# generate documentation
+cargo install comrak
+mkdir -p dist
+cp -r target/llvm-cov/html dist/coverage
+sed 's|CHANGELOG.md|CHANGELOG.html|g' README.md >README.md.tmp
+comrak --gfm -o dist/index.html --width 10 README.md.tmp
+comrak --gfm -o dist/CHANGELOG.html --width 10 CHANGELOG.md
+rm README.md.tmp

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Rust
+
+on:
+    push:
+        branches: ["main"]
+
+env:
+    CARGO_TERM_COLOR: always
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: "pages"
+    cancel-in-progress: true
+
+jobs:
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - name: Build
+              run: cargo build --verbose
+            - name: Build website
+              run: .github/workflows/build.sh
+            - name: Upload coverage artifact
+              uses: actions/[email protected]
+              with:
+                  path: "dist/"
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v1

.github/workflows/rust.yml → .github/workflows/tests.yml

@@ -10,18 +10,11 @@ env:
     CARGO_TERM_COLOR: always
 
 jobs:
-    build:
+    tests:
         runs-on: ubuntu-latest
-
         steps:
             - uses: actions/checkout@v3
             - name: Build
               run: cargo build --verbose
             - name: Run tests
               run: cargo test --verbose
-            - name: Coverage
-              run: cargo +stable install cargo-llvm-cov --locked && cargo llvm-cov --html
-            - name: Upload coverage artifact
-              uses: actions/[email protected]
-              with:
-                  path: "target/llvm-cov/html"

.gitignore

@@ -1,2 +1,3 @@
 /target
 .vscode/
+dist/

README.md

@@ -24,6 +24,11 @@ notox --do my_path
 | `-p`, `--json-pretty` | Output as JSON (prettified)  |
 | `-e`, `--json-error`  | Output as JSON (only errors) |
 
+## Infos
+
+- [Changelog](CHANGELOG.md)
+- [Coverage](https://its-just-nans.github.io/notox/coverage/)
+
 ## License
 
 - [MIT](LICENSE)