added doc files

obeznosov-LANL · Jan 8, 2025 · 8beab24 · 8beab24
1 parent a6c9a05
commit 8beab24
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 0 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,27 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '**'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '0.1.0'
+      - 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/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/devel.md b/docs/devel.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,16 @@
+using Pkg
+using Documenter
+
+makedocs(
+  sitename="hFlux",
+  authors = "Oleksii Beznosov",
+  format=Documenter.HTMLWriter.HTML(size_threshold = nothing),
+  pages = 
+  [
+    "Home" => "index.md",
+    "Quickstart Guide" => "quickstart.md",
+    "For Developers" => "devel.md"
+  ]
+)
+
+deploydocs(; repo = "github.com/obeznosov-LANL/hFlux")
diff --git a/docs/quickstart.md b/docs/quickstart.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[deps]
		Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"