Merge pull request #20 from JuliaAstro/docs

docs: created

Author: icweaver

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    tags: ["*"]
+  pull_request:
+    branches: [main]
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  docs:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "1"
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@releases/v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          GKSwstype: "100" # fix GKS socket error for plots made in @example blocks
+

.gitignore

@@ -2,4 +2,5 @@
 /deps/build.log
 /Artifacts.toml
 /build
-/products
+/products
+/docs/build

Project.toml

@@ -6,7 +6,7 @@ authors = ["Torrance Hodgson <torrance@pravic.xyz>", "Kiran Shila <me@kiranshila
 version = "0.4.0"
 
 [workspace]
-projects = ["test"]
+projects = ["test", "docs"]
 
 [deps]
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"