Merge pull request #2 from olivierbonte/feature/online_docs

Add Feature/online docs

.github/workflows/documentation.yml

@@ -0,0 +1,33 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - feature/online_docs # update to match your development branch (master, main, dev, trunk, ...)
+    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
+        working-directory: src/EvaporationModel
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        working-directory: src/EvaporationModel
+        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

Manifest.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.10.7"
 manifest_format = "2.0"
-project_hash = "afaa16a98bf6a64173d858191784cfe23ee4d803"
+project_hash = "db43f666a134364c840095edf60f1f88233cff4a"
 
 [[deps.ADTypes]]
 git-tree-sha1 = "016833eb52ba2d6bea9fcb50ca295980e728ee24"
@@ -601,7 +601,7 @@ uuid = "2702e6a9-849d-5ed8-8c21-79e8b8f9ee43"
 version = "0.0.20230411+0"
 
 [[deps.EvaporationModel]]
-deps = ["Bigleaf", "ComponentArrays", "DataFrames", "Parameters"]
+deps = ["Bigleaf", "ComponentArrays", "DataFrames", "LinearSolve", "Parameters"]
 path = "src/EvaporationModel"
 uuid = "49da8130-70c8-449e-9091-2395ad2fb07e"
 version = "0.1.0"

Project.toml

@@ -15,6 +15,7 @@ DrWatson = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 EvaporationModel = "49da8130-70c8-449e-9091-2395ad2fb07e"
 Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 LinearSolve = "7ed4a6bd-45f5-4d41-b270-4a48e9bafcae"
 NetCDF = "30363a11-5582-574a-97bb-aa9a979735b9"
 Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"

README.md

@@ -1,5 +1,7 @@
 # DifferentiableEvaporation
 
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://olivierbonte.github.io/DifferentiableEvaporation/dev/)
+
 This code base is using the [Julia Language](https://julialang.org/) and
 [DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)
 to make a reproducible scientific project named

src/EvaporationModel/docs/make.jl

@@ -1,3 +1,7 @@
 using Documenter, EvaporationModel
 
 makedocs(; sitename="EvaporationModel", pages=["Home" => "index.md"])
+
+deploydocs(;
+    repo="github.com/olivierbonte/DifferentiableEvaporation.git", push_preview=true
+)