Fix docs (#146)

* Add missing figures - doc * fix `index.md` file location * Add missing figures again * fix path * fix broken link * add submodules to docs
PTsolvers · May 6, 2024 · 49542d2 · 49542d2
1 parent 07812be
commit 49542d2
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 5 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -11,7 +11,7 @@ makedocs(;
 
     warnonly = Documenter.except(:footnote),
     pages=[
-        "Home"      => "man/index.md",
+        "Home"      => "index.md",
         "User guide"=> Any[
             "Installation" => "man/installation.md",
             "Backend"   => "man/backend.md",

diff --git a/docs/src/assets/Blankenbach_Temp.png b/docs/src/assets/Blankenbach_Temp.png
diff --git a/docs/src/assets/Blankenbach_Time_Series_V_Nu.png b/docs/src/assets/Blankenbach_Time_Series_V_Nu.png
diff --git a/docs/src/man/index.md → docs/src/index.md b/docs/src/man/index.md → docs/src/index.md
@@ -18,7 +18,7 @@ The package serves several purposes:
   * It provides a collection of solvers to be used in quickly developing new applications
   * It provides some standardization so that application codes can
 
-     - more easily handle local material properties through the use of [GeoParams.jl]((https://github.com/JuliaGeodynamics/GeoParams.jl))
+     - more easily handle local material properties through the use of [GeoParams.jl](https://github.com/JuliaGeodynamics/GeoParams.jl)
      - more easily switch between a pseudo-transient solver and another solvers (e.g. an explicit thermal solvers)
 
   * It provides a natural repository for contributions of new solvers for use by the larger community

diff --git a/docs/src/man/Blankenbach.md b/docs/src/man/Blankenbach.md
@@ -392,7 +392,7 @@ fig
 
 ### Final model
 Temperature field
-![Temperatuere](../assets/Blankenbach/Temp.png)
+![Temperature](../assets/Blankenbach_Temp.png)
 
 And time history of the rms-velocity and Nusselt number
-![time series](../assets/Blankenbach/Time_Series_V_Nu.png)
+![time series](../assets/Blankenbach_Time_Series_V_Nu.png)
diff --git a/docs/src/man/listfunctions.md b/docs/src/man/listfunctions.md
@@ -2,5 +2,5 @@
 
 Here an overview of all functions:
 ```@autodocs
-Modules = [JustRelax]
+Modules = [JustRelax, JustRelax.JustRelax2D, JustRelax.JustRelax3D, JustRelax.DataIO]
 ```