update docs

mcosovic · Oct 12, 2024 · d2d99a7 · d2d99a7
1 parent a8d2b60
commit d2d99a7
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 20 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,28 +2,25 @@ using Documenter, JuliaGrid
 using JuMP, HiGHS, Ipopt, GLPK
 using DocumenterCitations
 
-bib = CitationBibliography(
-    joinpath(@__DIR__, "src", "references.bib");
-    style=:numeric
-)
-
 makedocs(
     sitename = "JuliaGrid",
     modules = [JuliaGrid],
     clean = false,
     doctest = false,
-    plugins = [bib],
+    plugins = [
+        CitationBibliography(
+            joinpath(@__DIR__, "src", "background/references.bib");
+            style=:numeric
+        )
+    ],
     format = Documenter.HTML(
         assets = ["assets/tablestyle.css", "assets/citations.css"],
         prettyurls = get(ENV, "CI", nothing) == "true",
         collapselevel = 1
     ),
-    pages =
-        [
+    pages = [
         "Introduction" => "index.md",
-        "Installation Guide" => "installation.md",
-        "Manual" =>
-            [
+        "Manual" =>[
             "Power System Model" => "manual/powerSystemModel.md",
             "AC Power Flow" => "manual/acPowerFlow.md",
             "DC Power Flow" => "manual/dcPowerFlow.md",
@@ -33,9 +30,8 @@ makedocs(
             "AC State Estimation" => "manual/acStateEstimation.md",
             "PMU State Estimation" => "manual/pmuStateEstimation.md",
             "DC State Estimation" => "manual/dcStateEstimation.md"
-            ],
-        "Tutorials" =>
-            [
+        ],
+        "Tutorials" => [
             "Power System Model" => "tutorials/powerSystemModel.md",
             "AC Power Flow" => "tutorials/acPowerFlow.md",
             "DC Power Flow" => "tutorials/dcPowerFlow.md",
@@ -45,22 +41,24 @@ makedocs(
             "AC State Estimation" => "tutorials/acStateEstimation.md",
             "PMU State Estimation" => "tutorials/pmuStateEstimation.md",
             "DC State Estimation" => "tutorials/dcStateEstimation.md"
-            ],
-        "API Reference" =>
-            [
+        ],
+        "API Reference" =>[
             "Power System Model" => "api/powerSystemModel.md",
             "Power Flow" => "api/powerFlow.md",
             "Optimal Power Flow" => "api/optimalPowerFlow.md",
             "Measurement Model" => "api/measurementModel.md",
             "State Estimation" => "api/stateEstimation.md",
             "Power and Current Analysis" => "api/analysis.md",
             "Setup and Print" => "api/setupPrint.md"
-            ],
-        "Bibliography" => "bibliography.md",
+        ],
+        "Background" => [
+            "Installation Guide" => "background/installation.md",
+            "Bibliography" => "background/bibliography.md"
         ]
+    ]
 )
 
 deploydocs(
     repo = "github.com/mcosovic/JuliaGrid.jl.git",
     target = "build",
-)
+)
diff --git a/docs/src/bibliography.md → docs/src/background/bibliography.md b/docs/src/bibliography.md → docs/src/background/bibliography.md
diff --git a/docs/src/installation.md → docs/src/background/installation.md b/docs/src/installation.md → docs/src/background/installation.md
diff --git a/docs/src/references.bib → docs/src/background/references.bib b/docs/src/references.bib → docs/src/background/references.bib
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -14,6 +14,12 @@ The fremowork's architecture centres around code-reusability paradigm, allowing
 ### Installation Guide
 JuliaGrid is compatible with Julia version 1.9 and later. To get started with JuliaGrid, users should first install Julia and consider using a code editor for a smoother coding experience. For detailed instructions, please consult the [Installation Guide](@ref InstallationGuide).
 
+To get the JuliaGrid package installed, execute the following Julia command:
+```julia
+import Pkg
+Pkg.add("JuliaGrid")
+```
+
 ---
 
 ### Documentation Structure