update doc

HOPE-Model-Project · Dec 19, 2023 · 377cffb · 377cffb
1 parent e9113f6
commit 377cffb
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,17 +1,4 @@
-name = "HOPE"
-uuid = "2ce8c7c5-3207-4bce-8974-65cdad2c68ed"
-authors = ["swang22 <[email protected]> and contributors"]
-version = "1.0.0-DEV"
-
 [deps]
-DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
-JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
-
-[compat]
-julia = "1"
-
-[extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
-
-[targets]
-test = ["Test"]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+HOPE = "2ce8c7c5-3207-4bce-8974-65cdad2c68ed"
+DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
diff --git a/docs/make.jl b/docs/make.jl
@@ -16,6 +16,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "Reference" => "reference.md",
     ],
 )
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,9 +6,10 @@ CurrentModule = HOPE
 
 Documentation for [HOPE](https://github.com/SW/HOPE.jl).
 
-```@index
-```
+Package for Power System Modeling
+
+## Install
 
-```@autodocs
-Modules = [HOPE]
+```julia-repl
+pkg> add https://github.com/swang22/HOPE.jl
 ```
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = HOPE
+```
+
+```@index
+```
+
+```@autodocs
+Modules = [HOPE]
+```
diff --git a/src/HOPE.jl b/src/HOPE.jl
@@ -39,5 +39,6 @@ export get_TPmatched_ts
 export solve_model
 export write_outputs
 export run_hope
+export initiate_solver
 
 end
diff --git a/src/solver_config.jl b/src/solver_config.jl
@@ -1,4 +1,4 @@
-"""
+@doc raw"""
 
  - seconds = 1e-6
  - logLevel = 1e-6
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ makedocs(; @@
         ),
         pages=[
             "Home" => "index.md",
+            "Reference" => "reference.md",
         ],
     )
@@ Expand Down @@