Merge pull request #51 from NREL-Sienna/rh/hydro_docs

Add HydroPowerSimulations Docs

README.md

@@ -5,10 +5,14 @@
 [![Documentation Build](https://github.com/NREL-Sienna/HydroPowerSimulations.jl/actions/workflows/docs.yml/badge.svg)](https://nrel-sienna.github.io/HydroPowerSimulations.jl/dev/)
 [<img src="https://img.shields.io/badge/slack-@Sienna/HydroPowerSimulations-sienna.svg?logo=slack">](https://join.slack.com/t/nrel-sienna/shared_invite/zt-glam9vdu-o8A9TwZTZqqNTKHa7q3BpQ)
 
+`HydroPowerSimulations.jl` is an extension package of [`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/stable/) for modeling of hydro generation technology.
+
+For information on using the package, see the [stable documentation](https://nrel-sienna.github.io/HydroPowerSimulations.jl/stable/). Use the [in-development documentation](https://nrel-sienna.github.io/HydroPowerSimulations.jl/dev/) for the version of the documentation which contains the unreleased features.
+
 ## Development
 
-Contributions to the development and enahancement of HydroPowerSimulations is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
+Contributions to the development and enhancement of HydroPowerSimulations is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
 
 ## License
 
-HydroPowerSimulations is released under a BSD [license](https://github.com/NREL-Sienna/HydroPowerSimulations/blob/master/LICENSE). HydroPowerSimulations has been developed as part of the Flexible Linked Analysis of Streamflow and Hydropower (FLASH) and Reliability and Resilience of coordinated water Distribution and power Distribution (R2D2) projects at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/)) Software Record SWR-23-110
+HydroPowerSimulations is released under a BSD [license](https://github.com/NREL-Sienna/HydroPowerSimulations/blob/master/LICENSE). HydroPowerSimulations has been developed as part of the Flexible Linked Analysis of Streamflow and Hydropower (FLASH) and Reliability and Resilience of coordinated water Distribution and power Distribution (R2D2) projects at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/)) Software Record SWR-23-110.

docs/Project.toml

@@ -1,9 +1,16 @@
 [deps]
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
 HydroPowerSimulations = "fc1677e0-6ad7-4515-bf3a-bd6bf20a0b1b"
+Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
+PowerSimulations = "e690365d-45e2-57bb-ac84-44ba829e73c4"
+PowerSystemCaseBuilder = "f00506e0-b84f-492a-93c2-c0a9afc4364e"
+PowerSystems = "bcd98974-b02a-5e2f-9ee0-a103f5c450dd"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
 julia = "^1.6"

docs/make.jl

@@ -1,9 +1,18 @@
 using Documenter, HydroPowerSimulations
 import DataStructures: OrderedDict
+using DocumenterInterLinks
+
+links = InterLinks(
+    "PowerSystems" => "https://nrel-sienna.github.io/PowerSystems.jl/stable/",
+    "PowerSimulations" => "https://nrel-sienna.github.io/PowerSimulations.jl/stable/",
+    "InfrastructureSystems" => "https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/",
+)
 
 pages = OrderedDict(
     "Welcome Page" => "index.md",
     "Quick Start Guide" => "quick_start_guide.md",
+    "Tutorials" => Any["tutorials/single_stage_model.md"],
+    "Formulation Library" => "formulation.md",
     "Public API Reference" => "api/public.md",
     "Internal API Reference" => "api/internal.md",
 )
@@ -16,6 +25,7 @@ makedocs(
     ),
     sitename="HydroPowerSimulations.jl",
     pages=Any[p for p in pages],
+    plugins=[links],
 )
 
 deploydocs(

docs/src/api/internal.md

@@ -3,4 +3,5 @@
 ```@autodocs
 Modules = [HydroPowerSimulations]
 Public = false
+Private = true
 ```

docs/src/api/public.md

@@ -1,6 +1,83 @@
 # Public API Reference
 
+```@contents
+Pages = ["public.md"]
+Depth = 2
+```
+
+## Formulations
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = ["formulations.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Variables
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = ["variables.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Parameters
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = ["parameters.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Expressions
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = ["expressions.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Constraints
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = [ "constraints.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Initial Conditions
+
+```@autodocs
+Modules = [HydroPowerSimulations]
+Pages   = ["initial_conditions.jl",
+           ]
+Order = [:type, :function]
+Public = true
+Private = false
+```
+
+## Feedforwards
+
 ```@autodocs
 Modules = [HydroPowerSimulations]
+Pages   = ["feedforwards.jl",
+           ]
+Order = [:type, :function]
 Public = true
+Private = false
 ```