Merge pull request #99 from LukasFuchs/main

Add wrongly deleted make file again

Author: LukasFuchs

docs/make.jl

@@ -0,0 +1,99 @@
+using Documenter
+using GeoModBox
+
+GMB_root_dir = dirname(@__DIR__)
+
+license = read(joinpath(GMB_root_dir, "LICENSE"), String)
+write(joinpath(@__DIR__, "src", "man", "license.md"), license)
+
+makedocs(
+    sitename = "GeoModBox.jl",
+    format = Documenter.HTML(),
+    warnonly = [:missing_docs],
+    modules = [GeoModBox],
+    pages = [
+        "Home" => "index.md", # Checked! 
+        "Governing Equation" => Any[ # Checked! 
+            "Solution" => Any[
+                "General" => "man/GESolution.md", # checked!
+                "Initial Condition" => "man/Ini.md", # Checked!
+            ],
+            "Heat Diffusion Equation" => Any[
+                "General" => "man/DiffMain.md", # checked!
+                "1D" => "man/DiffOneD.md", # checked!
+                "2D" => "man/DiffTwoD.md", # checked! 
+            ],
+            "Advection Equation" => Any[
+                "General" => "man/AdvectMain.md", # Checked! 
+                "1D" => "man/AdvOneD.md", # Checked! 
+                "2D" => "man/AdvTwoD.md", # Checked!
+            ],
+            "Momentum Equation" => Any[
+                "General" => "man/MomentumMain.md", # Checked! 
+                "1D" => "man/MomentumOneD.md", # Checked! 
+                "2D" => "man/MomentumTwoD.md", # Checked!
+            ],
+        ],
+        "Exercises" => Any[
+            "General" => "man/Exercises.md",
+            "01 - Euler Advection" => "man/exercises/01_Euler_Advection.md", # Checked! 
+            "02 - 1D Heat Diffusion (explicit)" => "man/exercises/02_1D_Heat_explicit.md", # Checked! 
+            "03 - 1D Heat Diffusion (implicit)" => "man/exercises/03_1D_Heat_implicit.md", # Checked!
+            "04 - 2D Heat Diffusion (stationary)" => "man/exercises/04_2D_Diffusion_Stationary.md", # Checked!
+            "05a - 2D Heat Diffusion (Plume)" => "man/exercises/05_2D_Diffusion_TD_Plume.md", # Checked! 
+            "05b - 2D Heat Diffusion (Sill)" => "man/exercises/05_2D_Diffusion_TD_Sill.md", # Checked!
+            "06 - 1D Advection" => "man/exercises/06_1D_Advection.md", # Checked!
+            "07 - 2D Energy Conservation" => "man/exercises/07_2D_Energy_Equation.md", # Checked!
+            "08 - 1D Stokes" => "man/exercises/08_1D_Stokes.md", # Checked!
+            "09 - 2D Falling Block (steady state)" => "man/exercises/09_2D_Falling_Block.md", # Checked! 
+            "10 - 2D Falling Block (time-dep)" => "man/exercises/10_2D_Falling_Block_td.md", # Checked!
+            "11 - 2D Thermal Convection" => "man/exercises/11_2D_Thermal_Convection.md", # Checked!
+            "12 - 2D Thermal Convection (scaled)" => "man/exercises/12_2D_Thermal_Convection_scaled.md", # Checked!
+            # "13 - Blankenbach Benchmark" => "man/exercises/12_Blankenbach_Benchmark.md",
+        ],
+        "Examples" => Any[
+            "General" => "man/Examples.md",
+            "Diffusion Equation" => Any[
+                "Oceanic Geotherm (1D)" => "man/examples/OceanicGeotherm.md", # Checked! 
+                "Continental Geotherm (1D)" => "man/examples/ContinentalGeotherm.md", # Checked! 
+                "Gaussian Diffusion (1D)" => "man/examples/GaussianDiffusion1D.md", # Checked!  
+                "Backward Euler (2D)" => "man/examples/BackwardEuler_DC.md", # Checked!
+                "Forward Euler (2D)" => "man/examples/ForwardEuler_DC.md", # Checked! 
+                "Gaussian Diffusion (2D)" => "man/examples/GaussianDiffusion2D.md", # Checked!
+                "Poisson Problem (2D)" => "man/examples/PoissonRestest.md", # Checked!
+                "Poisson Problem; variable k (2D)" => "man/examples/PoissonVariablek.md", # Checked!
+            ],
+            "Advection Equtaion" => Any[
+                "Advection (2D)" => "man/examples/Advection2D.md", # Checked! 
+                "Advection Resolution Test (2D)" => "man/examples/AdvectionRestest2D.md", # Checked! 
+            ],
+            "Stokes Equation" => Any[
+                "Channel Flow (1D)" => "man/examples/ChannelFlow1D.md", # Checked! 
+                "Falling Block Benchmark" => "man/examples/FallingBlockBenchmark.md", # Checked! 
+                "Falling Block" => "man/examples/FallingBlockDC.md", # Checked! 
+                "Rayleigh Taylor Instability (RTI)" => "man/examples/RTI.md", # Checked!
+                "RTI - Growth Rate" => "man/examples/RTI_growth_rate.md", # Checked!
+                "Viscous Inclusion" => "man/examples/ViscousInclusion.md",
+            ],
+            "Mixed Thermal Convection" => Any[
+                "Bottom Heated" => "man/examples/BottomHeatedConvection.md",
+                "Internally Heated" => "man/examples/InternallyHeatedConvection.md",
+                "Mixed Heated" => "man/examples/MixedHeatedConvection.md",
+            ],
+        ],
+        "List of functions" => "man/listoffunctions.md",
+        "License" => "man/license.md",
+    ]
+)
+
+# Documenter can also automatically deploy documentation to gh-pages.
+# See "Hosting Documentation" and deploydocs() in the Documenter manual
+# for more information.
+withenv("GITHUB_REPOSITORY" => "GeoSci-FFM/GeoModBox.jl") do
+    deploydocs(
+        # repo = "https://lukasfuchs.github.io/GeoModBox.jl",
+        repo = "github.com/GeoSci-FFM/GeoModBox.jl",
+        devbranch = "main",
+        push_preview = true
+    )
+end