diff --git a/docs/make.jl b/docs/make.jl index bfa8f6c..085abc5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,7 +1,7 @@ using Documenter import DataStructures: OrderedDict using SiennaPRASInterface -using SiennaPRASInterface: PRASCore +using SiennaPRASInterface.PRASCore pages = OrderedDict( "Welcome Page" => "index.md", @@ -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( diff --git a/docs/src/api/internal.md b/docs/src/api/internal.md index ed2c219..b348b48 100644 --- a/docs/src/api/internal.md +++ b/docs/src/api/internal.md @@ -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 -``` - - +``` \ No newline at end of file diff --git a/src/SiennaPRASInterface.jl b/src/SiennaPRASInterface.jl index 1dabfae..a3feb2d 100644 --- a/src/SiennaPRASInterface.jl +++ b/src/SiennaPRASInterface.jl @@ -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 """ @@ -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,