Merge pull request #28 from NREL-Sienna/jd/fixdocs2

Jd/fixdocs2
NREL-Sienna · Feb 7, 2024 · 676061f · 676061f
2 parents 269022d + 3458829
commit 676061f
Show file tree

Hide file tree

Showing 17 changed files with 361 additions and 304 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1.6'
+          version: '1'
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy

diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Main - CI](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml/badge.svg)](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/actions/workflows/main-tests.yml)
 [![codecov](https://codecov.io/gh/NREL-Sienna/StorageSystemsSimulations.jl/branch/main/graph/badge.svg?token=sML4kPw4Z9)](https://codecov.io/gh/NREL-Sienna/StorageSystemsSimulations.jl)
+[![Documentation](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/workflows/Documentation/badge.svg)](https://nrel-sienna.github.io/StorageSystemsSimulations.jl/latest)
 [<img src="https://img.shields.io/badge/slack-@Sienna/PSY-sienna.svg?logo=slack">](https://join.slack.com/t/nrel-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ)
 
 ## Development

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,18 +1,16 @@
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
-Cbc = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
-DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
-GLPK = "60bf3e95-4087-53dc-ae20-288a0d20c6a6"
+HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
 InfrastructureSystems = "2cd47ed4-ca9b-11e9-27f2-ab636a7671f1"
 Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
-StorageSystemsSimulations = "e2f1a126-19d0-4674-9252-42b2384f8e3c"
+PowerSimulations = "e690365d-45e2-57bb-ac84-44ba829e73c4"
+PowerSystemCaseBuilder = "f00506e0-b84f-492a-93c2-c0a9afc4364e"
 PowerSystems = "bcd98974-b02a-5e2f-9ee0-a103f5c450dd"
-TimeSeries = "9e3dc215-6440-5c97-bce1-76c03772f85e"
+StorageSystemsSimulations = "e2f1a126-19d0-4674-9252-42b2384f8e3c"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
 InfrastructureSystems = "1"
-julia = "^1.6"
diff --git a/docs/make.jl b/docs/make.jl
@@ -6,25 +6,28 @@ using DataStructures
 pages = OrderedDict(
     "Welcome Page" => "index.md",
     "Quick Start Guide" => "quick_start_guide.md",
-    "Code Base Developer Guide" =>
-        Any["Developer Guide" => "code_base_developer_guide/developer.md",],
-    "Formulation Library" => Any["Storage" => "formulation_library/Storage.md",],
+    "Tutorials" =>
+        Any["tutorials/single_stage_model.md", "tutorials/simulation_tutorial.md"],
+    "Formulation Library" =>
+        Any["StorageDispatchWithReserves" => "formulation_library/StorageDispatchWithReserves.md",],
+    "Code Base Developer Guide" => "code_base_developer_guide/developer.md",
     "API Reference" => "api/StorageSystemsSimulations.md",
 )
 
 makedocs(;
     modules=[StorageSystemsSimulations],
     format=Documenter.HTML(; prettyurls=haskey(ENV, "GITHUB_ACTIONS")),
+    warnonly=[:missing_docs],
     sitename="StorageSystemsSimulations.jl",
-    authors="Sourabh Dalvi, Jose Daniel Lara",
+    authors="Jose Daniel Lara, Rodrigo Henriquez-Auba, Sourabh Dalvi",
     pages=Any[p for p in pages],
 )
 
 deploydocs(;
     repo="github.com/NREL-Sienna/StorageSystemsSimulations.jl.git",
     target="build",
     branch="gh-pages",
-    devbranch="master",
+    devbranch="main",
     devurl="dev",
     push_preview=true,
     versions=["stable" => "v^", "v#.#"],

diff --git a/docs/src/api/StorageSystemsSimulations.md b/docs/src/api/StorageSystemsSimulations.md
@@ -7,24 +7,12 @@ DocTestSetup  = quote
 end
 ```
 
-API documentation
-
-```@contents
-Pages = ["StorageSystemsSimulations.md"]
-```
-
-## Index
-
-```@index
-Pages = ["StorageSystemsSimulations.md"]
-```
-
 ## Exported
 
 ```@autodocs
 Modules = [StorageSystemsSimulations]
 Private = false
-Filter = t -> typeof(t) === DataType ? !(t <: Union{StorageSystemsSimulations.AbstractStorageFormulation}) : true
+Filter = t -> typeof(t) === DataType ? !(t <: StorageSystemsSimulations.AbstractStorageFormulation) : true
 ```
 
 ## Internal

diff --git a/docs/src/code_base_developer_guide/developer.md b/docs/src/code_base_developer_guide/developer.md
@@ -1,11 +1,11 @@
 # Guidelines for Developers
 
-In order to contribute to `PowerSystems.jl` repository please read the following sections of
+In order to contribute to `StorageSystemsSimulations.jl` repository please read the following sections of
 [`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
 documentation in detail:
 
  1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
- 2. [Contributing Guidelines](https://github.com/NREL-Sienna/PowerSystems.jl/blob/master/CONTRIBUTING.md)
+ 2. [Contributing Guidelines](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md)
 
 Pull requests are always welcome to fix bugs or add additional modeling capabilities.
 

diff --git a/docs/src/formulation_library/README.md b/docs/src/formulation_library/README.md
diff --git a/docs/src/formulation_library/Storage.md b/docs/src/formulation_library/Storage.md