Implement Documenter documentation pages (#58)

* Add Documenter * Create basic Hello World template * Add GitHub Action and deployment * Bump Julia version for compat with Meshes * Update main page * Bump patch version
JuliaGeometry · Sep 1, 2024 · 7109902 · 7109902 · mikeingold · Sep 1, 2024
1 parent feb56fd
commit 7109902
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 1 deletion.
diff --git a/.github/workflows/documentation.yml b/.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.9'
+      - uses: julia-actions/cache@v1
+      - 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
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "MeshIntegrals"
 uuid = "dadec2fd-bbe0-4da4-9dbe-476c782c8e47"
 authors = ["Mike Ingold <[email protected]>"]
-version = "0.13.0"
+version = "0.13.1"
 
 [deps]
 CoordRefSystems = "b46f11dc-f210-4604-bfba-323c1ec968cb"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+MeshIntegrals = "dadec2fd-bbe0-4da4-9dbe-476c782c8e47"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,6 @@
+using Documenter
+using MeshIntegrals
+
+makedocs(sitename="MeshIntegrals.jl Documentation")
+
+deploydocs(repo = "github.com/mikeingold/MeshIntegrals.jl.git")
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,4 @@
+# MeshIntegrals.jl
+
+**MeshIntegrals.jl** is a Julia library that leverages differential forms to implement fast
+and easy numerical integration of field equations over geometric domains.