First attempt on adding docs

.github/workflows/make_docs.yml

@@ -0,0 +1,29 @@
+name: Make Docs
+on:
+  push:
+    branches:
+      - master
+      - docs
+    paths:
+      - '.github/workflows/make_docs.yml'
+      - 'src/'
+      - 'docs/**'
+    tags: '*'
+jobs:
+  make_docs:
+    permissions:
+      contents: write
+      statuses: write
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/julia-docdeploy@v1
+      - name: Install dependencies
+        run: |
+          julia --project=docs/ -e 'using Pkg; Pkg.add(; url="[email protected]:ProjectTorreyPines/IMASDD.jl.git", rev="master"); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia --project=docs/ docs/make.jl

docs/Project.toml

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

docs/make.jl

@@ -0,0 +1,12 @@
+using Documenter
+using GGDUtils
+
+makedocs(;
+    modules=[GGDUtils],
+    format=Documenter.HTML(),
+    sitename="GGDUtils",
+)
+
+deploydocs(;
+    repo="github.com/ProjectTorreyPines/GGDUtils.jl.git",
+)

docs/src/index.md

@@ -0,0 +1,25 @@
+
+# GGDUtils.jl 
+
+## Installation
+
+Clone the repo and run make command:
+
+```bash
+% GGDUtils % make help
+Help Menu
+
+make env_with_cloned_repo (or make r): Creates a Julia environment with the cloned repositories
+make env_with_git_url (or make u): Creates a Julia environment with the git urls without creating local clones
+make clean: Deletes Project.toml and Manifest.toml for a fresh start
+```
+
+## Interpolations
+
+Several interpolation functions are available to create interpolaiton functions for data present in a GGD represented over a particular grid subset:
+
+```@docs
+interp
+get_TPS_mats
+get_kdtree
+```