Merge pull request #21 from LAMPSPUC/jg/docs

Create documentation.yml

Author: joaquimg

.github/workflows/documentation.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      actions: write
+      contents: write
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - 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

docs/make.jl

@@ -1,13 +1,14 @@
-using Documenter
+import Documenter
 
-push!(LOAD_PATH, "../src")
 using ApplicationDrivenLearning
 
-makedocs(;
-    modules = [ApplicationDrivenLearning],
-    doctest = false,
+Documenter.makedocs(;
     clean = true,
-    sitename = "ApplicationDrivenLearning.jl",
+    sitename = "ApplicationDrivenLearning.jl documentation",
     authors = "Giovanni Amorim, Joaquim Garcia",
-    pages = ["Home" => "index.md", "API Reference" => "reference.md"],
+)
+
+Documenter.deploydocs(;
+    repo = "github.com/LAMPSPUC/ApplicationDrivenLearning.jl.git",
+    push_preview = true,
 )