Skip to content

Commit

Permalink
Fix docs by ignoring warnings (it's a problem in PRAS.jl)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph McKinsey committed Jan 22, 2025
1 parent 588c899 commit 9499b01
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
5 changes: 3 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using Documenter
import DataStructures: OrderedDict
using SiennaPRASInterface
using SiennaPRASInterface: PRASCore
using SiennaPRASInterface.PRASCore

pages = OrderedDict(
"Welcome Page" => "index.md",
Expand All @@ -22,7 +22,8 @@ makedocs(
sitename="github.com/NREL-Sienna/SiennaPRASInterface.jl",
authors="Surya Dhulipala, Joseph McKinsey, José Daniel Lara",
pages=Any[p for p in pages],
draft=false,
warnonly = true,
#draft=false,
)

deploydocs(
Expand Down
10 changes: 4 additions & 6 deletions docs/src/api/internal.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Internal API

```@docs
PRASCore.Simulations.DispatchProblem
PRASCore.Results.StorageAvailability
Simulations.DispatchProblem
Results.StorageAvailability
```

```@autodocs
Modules = [SiennaPRASInterface, PRASCore]
Modules = [SiennaPRASInterface, SiennaPRASInterface.PRASCore]
Public = false
```


```
4 changes: 2 additions & 2 deletions src/SiennaPRASInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PowerSystems Interface for Probabilistic Resource Adequacy Studies (PRAS)
- [`SystemModel`](@ref): PRAS data structure
- [`SequentialMonteCarlo`](@ref): method for PRAS analysis
- `Shortfall`: PRAS metric for missing generation
- [`Shortfall`](@ref): PRAS metric for missing generation
- [`LOLE`](@ref): PRAS metric for loss of load expectation
- [`EUE`](@ref): PRAS metric for energy unserved expectation
"""
Expand Down Expand Up @@ -134,7 +134,7 @@ Estimate resource adequacy using Monte Carlo simulation.
# Returns
- Tuple of results from `resultsspec`: default is (`ShortfallResult`,)
- Tuple of results from `resultsspec`: default is ([`ShortfallResult`](@ref),)
"""
function PRASCore.assess(
sys::PSY.System,
Expand Down

0 comments on commit 9499b01

Please sign in to comment.