[#17]:svarga:docs, integrate documenter.jl with github pages

Author: steven-varga

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main  # or "master" if that’s your default
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.11'
+
+      - name: Install dependencies
+        run: julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()'
+        
+      - name: Build and deploy docs
+        run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,6 +1,9 @@
 [![CI](https://github.com/vargaconsulting/tiny-crypto/actions/workflows/ci.yml/badge.svg)](https://github.com/vargaconsulting/tiny-crypto/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/vargaconsulting/tiny-crypto/branch/main/graph/badge.svg)](https://codecov.io/gh/vargaconsulting/tiny-crypto)
 [![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![DOI](https://zenodo.org/badge/950847209.svg)](https://doi.org/10.5281/zenodo.15492419)
+[![GitHub release](https://img.shields.io/github/v/release/vargaconsulting/tiny-crypto.svg)](https://github.com/vargaconsulting/tiny-crypto/releases)
+[![Documentation](https://img.shields.io/badge/docs-stable-blue)](https://vargaconsulting.github.io/tiny-crypto)
 
 # Tiny Crypto – Exploring Cryptography with Small Prime Fields
 

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -0,0 +1,16 @@
+using Documenter, TinyCrypto
+push!(LOAD_PATH,"../src/")
+
+makedocs(
+    sitename = "TinyCrypto.jl",
+    modules = [TinyCrypto],
+    pages = [
+        "Home" => "index.md",
+        "Utility Functions" => "utils.md",
+    ],
+)
+
+deploydocs(
+    repo = "github.com/vargaconsulting/tiny-crypto.git",
+    devbranch = "main",
+)